docs: add some config options with "support" column #365
Conversation
rauno56
force-pushed
the
docs/all-config-options
branch
from
12d9f9d to
c45de35
Compare
Codecov Report
@@ Coverage Diff @@
## main #365 +/- ##
=======================================
Coverage 93.63% 93.63%
=======================================
Files 9 9
Lines 330 330
Branches 87 87
=======================================
Hits 309 309
Misses 21 21 Continue to review full report at Codecov.
|
rauno56
force-pushed
the
docs/all-config-options
branch
from
8e01d34 to
45f398c
Compare
rauno56
force-pushed
the
docs/all-config-options
branch
from
efdd7b0 to
81d82e1
Compare
docs/advanced-config.md
Outdated
| | `OTEL_BSP_EXPORT_TIMEOUT` | `30000` | Stable | Maximum allowed time to export data | ||
| | `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` | `512` | Stable | Maximum batch size Must be less than or equal to OTEL_BSP_MAX_QUEUE_SIZE | ||
| | `OTEL_BSP_MAX_QUEUE_SIZE` | `2048` | Stable | Maximum queue size | ||
| | `OTEL_BSP_SCHEDULE_DELAY` | `5000` | Stable | Delay interval between two consecutive exports | ||
| | `OTEL_EXPORTER_JAEGER_ENDPOINT` | `http://localhost:14268/v1/traces` or<br>`http://localhost:9080/v1/trace`<br>if `jaeger-thrift-splunk` is used as exporter | Stable | HTTP endpoint for Jaeger traces | ||
| | `OTEL_EXPORTER_JAEGER_PASSWORD` | | Stable | Password to be used for HTTP basic authentication | ||
| | `OTEL_EXPORTER_JAEGER_USER` | | Stable | Username to be used for HTTP basic authentication |
There was a problem hiding this comment.
There are currently not in the official docs (except the Jaeger endpoint env var). Are they relevant to Splunk O11y Cloud?
There was a problem hiding this comment.
:) I mean... they are configuration options for our client!
I would rather not add them here even - they're standard OTel env vars that are (eventually) supported by every distro. "eventually" is the key though - the stability and the changed defaults are the only practical reason to do it.
There was a problem hiding this comment.
I think we shall document only those config settings that are required to use our OTel distributions, or that are relevant to the setup process of using Splunk O11y Cloud as backend, or to troubleshoot issues when connecting to Splunk O11y Cloud. Consider OTEL_EXPORTER_JAEGER_PASSWORD: Splunk isn't a Jaeger backend, and our customers never need to set a Jaeger password. We don't need to document it even if we support it.
Description
I'm (somewhat reluctantly) adding some config options and the "support" column.
Type of change
Checklist: