Update docs with tracing options

Kuadrant · Feb 21, 2024 · 7d65cea · 7d65cea
1 parent 391cfbb
commit 7d65cea
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git 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 <tracing_host>
+          The host for the tracing service
+      --tracing-port <tracing_port>
+          The port for the tracing service [default: 4317]
       --validate
           Validates the LIMITS_FILE and exits
   -H, --rate-limit-headers <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
@@ -37,6 +37,10 @@ Options:
           Include the Limit Name in prometheus label
   -v...
           Sets the level of verbosity
+      --tracing-host <tracing_host>
+          The host for the tracing service
+      --tracing-port <tracing_port>
+          The port for the tracing service [default: 4317]
       --validate
           Validates the LIMITS_FILE and exits
   -H, --rate-limit-headers <rate_limit_headers>