Skip to content

Commit e3bad6a

Browse files
committed
docs(tracing): processing PR feedback, clarify endpoint format and add deployment docs
1 parent 3025734 commit e3bad6a

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

docs/CONFIGURATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ Environment variables use the prefix `KNPT_` followed by the configuration path
4545
| `KNPT_MITZ_TLSKEYPASSWORD` | `mitz.tlskeypassword` | Password for .p12/.pfx |
4646
| `KNPT_MITZ_TLSCAFILE` | `mitz.tlscafile` | Path to server certificate |
4747
| **Tracing / OpenTelemetry** | | |
48-
| `KNPT_TRACING_OTLPENDPOINT` | `tracing.otlpendpoint` | OTLP HTTP endpoint (host:port) for sending traces. Tracing is enabled when this is set.<br/>Example: `jaeger:4318`. |
48+
| `KNPT_TRACING_OTLPENDPOINT` | `tracing.otlpendpoint` | OTLP collector address as `host:port`. Tracing is enabled when this is set.<br/>Example: `jaeger:4318`. |
4949
| `KNPT_TRACING_INSECURE` | `tracing.insecure` | Use insecure (non-TLS) connection to OTLP endpoint.<br/>Defaults to `true`. |
5050
| `KNPT_TRACING_SERVICENAME` | `tracing.servicename` | Service name reported in traces.<br/>Defaults to `nuts-knooppunt`. |

docs/DEPLOYMENT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,13 @@ The Knooppunt can be deployed with an embedded Nuts node. If a vendor has an exi
8787
or wants to have the Nuts node deployed separately, the Knooppunt can use that Nuts node instead.
8888
8989
Use [`nuts.enabled`](./CONFIGURATION.md) to configure the embedded or existing Nuts node.
90+
91+
### Tracing
92+
93+
The Knooppunt supports distributed tracing using OpenTelemetry. Traces can be sent to any OTLP-compatible collector (e.g. Jaeger, Grafana Tempo, or a vendor's existing observability platform).
94+
95+
To enable tracing, set [`tracing.otlpendpoint`](./CONFIGURATION.md) to the address of your OTLP collector.
96+
97+
Span names are formatted as `METHOD /path` (e.g. `POST /mcsd/update`). The component can be identified from the path prefix (`/mcsd/*`, `/nvi/*`, `/pdp/*`) and filtered using the `http.target` tag.
98+
99+
See [CONFIGURATION.md](./CONFIGURATION.md) for all tracing options.

0 commit comments

Comments
 (0)