cleaned bottom references
This commit is contained in:
@@ -1,17 +1,17 @@
|
||||
# Bottom OpenTelemetry Docker Compose Setup
|
||||
# Symon OpenTelemetry Docker Compose Setup
|
||||
|
||||
This directory contains a Docker Compose setup for running an observability stack to monitor Bottom with OpenTelemetry.
|
||||
This directory contains a Docker Compose setup for running an observability stack to monitor Symon with OpenTelemetry.
|
||||
|
||||
## Architecture
|
||||
|
||||
The stack includes:
|
||||
|
||||
1. **OpenTelemetry Collector** - Receives metrics from Bottom via OTLP protocol
|
||||
1. **OpenTelemetry Collector** - Receives metrics from Symon via OTLP protocol
|
||||
2. **Prometheus** - Scrapes and stores metrics from the OTEL Collector
|
||||
3. **Grafana** - Visualizes metrics from Prometheus
|
||||
|
||||
```
|
||||
Bottom (with --headless flag)
|
||||
Symon (with --headless flag)
|
||||
↓ (OTLP/gRPC on port 4317)
|
||||
OpenTelemetry Collector
|
||||
↓ (Prometheus scrape on port 8889)
|
||||
@@ -34,7 +34,7 @@ This will start:
|
||||
- Prometheus on port 9090
|
||||
- Grafana on port 3000
|
||||
|
||||
### 2. Build Bottom with OpenTelemetry support
|
||||
### 2. Build Symon with OpenTelemetry support
|
||||
|
||||
```bash
|
||||
cd ..
|
||||
@@ -43,13 +43,13 @@ cargo build --release --features opentelemetry
|
||||
|
||||
### 3. Create a configuration file
|
||||
|
||||
Create a `bottom-config.toml` file:
|
||||
Create a `Symon-config.toml` file:
|
||||
|
||||
```toml
|
||||
[opentelemetry]
|
||||
enabled = true
|
||||
endpoint = "http://localhost:4317"
|
||||
service_name = "bottom-system-monitor"
|
||||
service_name = "Symon-system-monitor"
|
||||
export_interval_ms = 5000
|
||||
|
||||
[opentelemetry.metrics]
|
||||
@@ -62,10 +62,10 @@ temperature = true
|
||||
gpu = true
|
||||
```
|
||||
|
||||
### 4. Run Bottom in headless mode
|
||||
### 4. Run Symon in headless mode
|
||||
|
||||
```bash
|
||||
./target/release/btm --config bottom-config.toml --headless
|
||||
./target/release/btm --config Symon-config.toml --headless
|
||||
```
|
||||
|
||||
Or without config file:
|
||||
@@ -93,11 +93,11 @@ Configures the OpenTelemetry Collector to:
|
||||
|
||||
Configures Prometheus to:
|
||||
- Scrape metrics from the OTEL Collector every 10 seconds
|
||||
- Load alerting rules from `rules/bottom_rules.yml`
|
||||
- Load alerting rules from `rules/Symon_rules.yml`
|
||||
|
||||
### rules/bottom_rules.yml
|
||||
### rules/Symon_rules.yml
|
||||
|
||||
Contains Prometheus recording rules for Bottom metrics, including:
|
||||
Contains Prometheus recording rules for Symon metrics, including:
|
||||
- Recent process CPU usage metrics
|
||||
- Recent process memory usage metrics
|
||||
|
||||
@@ -132,11 +132,11 @@ topk(10, system_process_memory_usage_bytes)
|
||||
|
||||
Grafana is automatically configured with:
|
||||
- **Prometheus data source** (http://prometheus:9090) - pre-configured
|
||||
- **Bottom System Overview dashboard** - pre-loaded
|
||||
- **Symon System Overview dashboard** - pre-loaded
|
||||
|
||||
To access:
|
||||
1. Go to http://localhost:3000 (username: `admin`, password: `admin`)
|
||||
2. Navigate to Dashboards → Browse → "Bottom System Overview"
|
||||
2. Navigate to Dashboards → Browse → "Symon System Overview"
|
||||
|
||||
The dashboard includes:
|
||||
- CPU usage by core
|
||||
@@ -160,7 +160,7 @@ docker-compose down -v
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Bottom not sending metrics
|
||||
### Symon not sending metrics
|
||||
|
||||
Check the OTEL Collector logs:
|
||||
```bash
|
||||
@@ -178,7 +178,7 @@ You should see messages about receiving metrics.
|
||||
|
||||
1. Verify Prometheus data source is configured correctly
|
||||
2. Check that Prometheus has data by querying directly
|
||||
3. Ensure your time range in Grafana includes when Bottom was running
|
||||
3. Ensure your time range in Grafana includes when Symon was running
|
||||
|
||||
## Advanced Configuration
|
||||
|
||||
@@ -188,7 +188,7 @@ A TimescaleDB configuration file is available as `docker-compose-timescale.yml.k
|
||||
|
||||
### Custom Prometheus Rules
|
||||
|
||||
Edit `rules/bottom_rules.yml` to add custom recording or alerting rules.
|
||||
Edit `rules/Symon_rules.yml` to add custom recording or alerting rules.
|
||||
|
||||
### OTEL Collector Sampling
|
||||
|
||||
|
||||
Reference in New Issue
Block a user