Repository documentation gaps (config params, manual instrumentation, log correlation)

[pmcollins]

Summary

The repository is missing inline documentation for several areas required by the GDI specification. These may be covered on docs.splunk.com — if so, this issue is to verify coverage and add pointers from the repo.

Spec requirement

GDI Specification v1.8.0 — repository.md (Instrumentation Libraries):

• MUST document all configuration parameters that are relevant to Splunk Observability Cloud
• MUST document all configuration parameters whose default or accepted values deviate from upstream
• MUST document how to configure manual instrumentation
• MUST document how to configure log correlation
• MUST define minimum supported version of each auto-instrumentation framework

Note: the spec also says documentation MAY be hosted in the Observability Cloud documentation repository (docs.splunk.com).

Current state

README.md links to official Splunk docs for setup but does not itself contain:

• A table of Splunk-specific config params and their defaults
• Params whose defaults deviate from upstream OTel (e.g. OTEL_TRACES_SAMPLER=always_on, OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT=12000)
• Manual instrumentation guide or link
• Log correlation guide or link
• Minimum supported framework versions

Expected

Either add the above content to the repo (README or dedicated docs), or verify it is covered on docs.splunk.com and add direct links from the README.

References

• README.md
• src/splunk_otel/env.py (all defaults are defined here)