From 7d65cea96ffeb4469e9a0943146d49009b3a6204 Mon Sep 17 00:00:00 2001 From: Adam Cattermole Date: Wed, 21 Feb 2024 11:23:31 +0000 Subject: [PATCH] Update docs with tracing options --- doc/server/configuration.md | 16 ++++++++++++++++ limitador-server/README.md | 4 ++++ 2 files changed, 20 insertions(+) diff --git a/doc/server/configuration.md b/doc/server/configuration.md index 2cfb8d4f..040597be 100644 --- a/doc/server/configuration.md +++ b/doc/server/configuration.md @@ -31,6 +31,10 @@ Options: Include the Limit Name in prometheus label -v... Sets the level of verbosity + --tracing-host + The host for the tracing service + --tracing-port + The port for the tracing service [default: 4317] --validate Validates the LIMITS_FILE and exits -H, --rate-limit-headers @@ -326,6 +330,18 @@ docs](https://prometheus.io/docs/practices/naming/#labels) - Optional. Disabled by default. - Format: `bool`, set to `"1"` to enable. +#### `TRACING_HOST` + +- Host of the OTLP tracing collector. +- Optional. Default to `""` (tracing disabled) +- Format: `string` + +#### `TRACING_PORT` + +- Port of the OTLP tracing collector. +- Optional. Defaults to `4317`. +- Format: `integer`. + #### `REDIS_LOCAL_CACHE_ENABLED` - Enables a storage implementation that uses Redis, but also caches some data in diff --git a/limitador-server/README.md b/limitador-server/README.md index 0fda9add..166c27ae 100644 --- a/limitador-server/README.md +++ b/limitador-server/README.md @@ -37,6 +37,10 @@ Options: Include the Limit Name in prometheus label -v... Sets the level of verbosity + --tracing-host + The host for the tracing service + --tracing-port + The port for the tracing service [default: 4317] --validate Validates the LIMITS_FILE and exits -H, --rate-limit-headers