pangolin_mirror/newt
1
0
Fork 0
mirror of https://github.com/fosrl/newt.git synced 2026-03-26 20:46:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Update observability documentation to correct code block syntax and improve clarity

Browse Source
This commit is contained in:
Marc Schäfer
2025-10-08 00:00:56 +02:00
parent 59e8d79404
commit d91c6ef168
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/observability.md
View File

@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD033 -->
# OpenTelemetry Observability for Newt # OpenTelemetry Observability for Newt
This document describes how Newt exposes metrics using the OpenTelemetry (OTel) Go SDK, how to enable Prometheus scraping, and how to send data to an OpenTelemetry Collector for further export. This document describes how Newt exposes metrics using the OpenTelemetry (OTel) Go SDK, how to enable Prometheus scraping, and how to send data to an OpenTelemetry Collector for further export.
@@ -92,7 +93,7 @@ OTLP TLS example
- Enable TLS to Collector with a custom CA and headers: - Enable TLS to Collector with a custom CA and headers:
``` ```sh
NEWT_METRICS_OTLP_ENABLED=true \ NEWT_METRICS_OTLP_ENABLED=true \
OTEL_EXPORTER_OTLP_ENDPOINT=collector:4317 \ OTEL_EXPORTER_OTLP_ENDPOINT=collector:4317 \
OTEL_EXPORTER_OTLP_INSECURE=false \ OTEL_EXPORTER_OTLP_INSECURE=false \
@@ -107,7 +108,7 @@ Important: Do not scrape both Newt (2112) and the Collector’s Prometheus expor
A) Scrape Newt directly: A) Scrape Newt directly:
``` ```yaml
global: global:
scrape_interval: 15s scrape_interval: 15s
scrape_configs: scrape_configs:
@@ -118,7 +119,7 @@ scrape_configs:
B) Scrape the Collector’s Prometheus exporter: B) Scrape the Collector’s Prometheus exporter:
``` ```yaml
global: global:
scrape_interval: 15s scrape_interval: 15s
scrape_configs: scrape_configs:
@@ -142,19 +143,19 @@ PromQL snippets
- Throughput in (5m): - Throughput in (5m):
``` ```sh
sum(rate(newt_tunnel_bytes_total{direction="in"}[5m])) sum(rate(newt_tunnel_bytes_total{direction="in"}[5m]))
``` ```
- P95 latency (seconds): - P95 latency (seconds):
``` ```sh
histogram_quantile(0.95, sum(rate(newt_tunnel_latency_seconds_bucket[5m])) by (le)) histogram_quantile(0.95, sum(rate(newt_tunnel_latency_seconds_bucket[5m])) by (le))
``` ```
- Active sessions: - Active sessions:
``` ```sh
sum(newt_tunnel_sessions) sum(newt_tunnel_sessions)
``` ```