Skip to content

Commit 9f2f398

Browse files
author
Datanoise
committed
feat: provide example Prometheus configuration and update README for monitoring setup.
1 parent 8d64bb9 commit 9f2f398

2 files changed

Lines changed: 23 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -307,13 +307,14 @@ TinyIce provides built-in support for real-time monitoring via Prometheus.
307307
- **Throughput**: Bytes in/out and dropped packets (health ratio).
308308
- **System**: Memory usage, goroutine counts, GC statistics, and server uptime.
309309

310-
### Grafana Dashboard
311-
A pre-configured Grafana dashboard is available in the repository:
312-
👉 **[monitoring/grafana-dashboard.json](monitoring/grafana-dashboard.json)**
313-
314-
To use it:
315-
1. Ensure Prometheus is scraping your TinyIce instance.
316-
2. Import the JSON file into your Grafana instance.
310+
### Grafana Dashboard & Prometheus Config
311+
Example monitoring configurations are available in the repository:
312+
- 📊 **[monitoring/grafana-dashboard.json](monitoring/grafana-dashboard.json)**
313+
- ⚙️ **[monitoring/prometheus.yml](monitoring/prometheus.yml)**
314+
315+
To use them:
316+
1. Add the contents of `prometheus.yml` to your Prometheus configuration (update targets and auth).
317+
2. Import the Grafana JSON file into your Grafana instance.
317318
3. Select your Prometheus data source.
318319

319320
## Command Line Usage

monitoring/prometheus.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Example Prometheus configuration for TinyIce
2+
# To use this:
3+
# 1. Update the 'targets' with your TinyIce server address
4+
# 2. Update 'username' and 'password' with your TinyIce admin credentials
5+
# 3. Add this scrape_config to your existing prometheus.yml
6+
7+
scrape_configs:
8+
- job_name: 'tinyice'
9+
scrape_interval: 5s
10+
metrics_path: '/metrics'
11+
static_configs:
12+
- targets: ['127.0.0.1:8002']
13+
basic_auth:
14+
username: 'admin'
15+
password: 'password' # Use the password generated on first run or set in tinyice.json

0 commit comments

Comments
 (0)