Skip to content

[otlp-exporters] document all OTLPExporterNodeConfigBase options #6724

Description

@pichlermarc

Description:

Users trying to configure OTLP*Exporter (from @opentelemetry/exporter-metrics-otlp-proto or similar) have no easy way to discover the relevant configuration options through the README chain.

Proposed Solution

  • Document all options available on OTLPExporterNodeConfigBase
    • using tsdoc on the type
    • in the @opentelemetry/otlp-exporter-base README (including httpAgentOptions and any other shared config fields)
  • Add a easy-to-find link in each individual OTLP http exporter README (e.g. exporter-metrics-otlp-proto, exporter-trace-otlp-proto, etc.) pointing to @opentelemetry/otlp-exporter-base for shared options

Out of scope

  • Fixing broken type links in auto-generated API docs (separate issue)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    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