Skip to content

Document declarative (file-based) configuration #5308

@MikeGoldsmith

Description

@MikeGoldsmith

What

The SDK supports declarative configuration (loading the SDK from a YAML/JSON file per the configuration spec), but there is no user-facing documentation for it. Go and Java document this flow; Python should too so it can be recommended for the common "point the SDK at a YAML file" use case.

Scope

  • A guide/reference page under docs/sdk/ covering:
    • enabling via OTEL_CONFIG_FILE
    • applying programmatically via the public opentelemetry.sdk.configuration API
    • the file-configuration install extra
    • environment variable substitution
  • A runnable example under docs/examples/declarative-config/ (config YAML + app).

Dependencies

Part of the declarative configuration effort tracked in #3631.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions