Merge pull request #4351 from WhitWaldo/tweak-otel-tracing-endpoint

Tweaked the observability endpoint description and examples to reflect that the protocol may not be necessary
This commit is contained in:
Hannah Hunter 2024-09-13 12:54:23 -04:00 committed by GitHub
commit b7dc4a3e51
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions

View File

@ -86,7 +86,7 @@ The `tracing` section under the `Configuration` spec contains the following prop
tracing:
samplingRate: "1"
otel:
endpointAddress: "https://..."
endpointAddress: "otelcollector.observability.svc.cluster.local:4317"
zipkin:
endpointAddress: "http://zipkin.default.svc.cluster.local:9411/api/v2/spans"
```
@ -97,10 +97,10 @@ The following table lists the properties for tracing:
|--------------|--------|-------------|
| `samplingRate` | string | Set sampling rate for tracing to be enabled or disabled.
| `stdout` | bool | True write more verbose information to the traces
| `otel.endpointAddress` | string | Set the Open Telemetry (OTEL) server address to send traces to
| `otel.endpointAddress` | string | Set the Open Telemetry (OTEL) server address to send traces to. This may or may not require the https:// or http:// depending on your OTEL provider.
| `otel.isSecure` | bool | Is the connection to the endpoint address encrypted
| `otel.protocol` | string | Set to `http` or `grpc` protocol
| `zipkin.endpointAddress` | string | Set the Zipkin server address to send traces to
| `zipkin.endpointAddress` | string | Set the Zipkin server address to send traces to. This should include the protocol (http:// or https://) on the endpoint.
##### `samplingRate`