Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: OpenTelemetry Collector example exporter config is misleading #13551

Closed
axw opened this issue Jul 3, 2024 · 1 comment · Fixed by elastic/observability-docs#4397
Closed
Assignees
Labels
Team:Docs Label for the Observability docs team

Comments

@axw
Copy link
Member

axw commented Jul 3, 2024

https://www.elastic.co/guide/get-started/current/open-telemetry-elastic.html#open-telemetry-collector has sample OpenTelemetry Collector exporter config, and uses the name "otlp/elastic" for the exporter:

exporters:
  logging:
    loglevel: warn 
  otlp/elastic: 
    # Elastic APM server https endpoint without the "https://" prefix
    endpoint: "${ELASTIC_APM_SERVER_ENDPOINT}"  
    headers:
      # Elastic APM Server secret token
      Authorization: "Bearer ${ELASTIC_APM_SERVER_TOKEN}"

The "otlp/elastic" name is using the syntax described at https://opentelemetry.io/docs/collector/configuration/#exporters to name a specific instance of the "otlp" exporter:

Note that receivers, processors, exporters and pipelines are defined through component identifiers following the type[/name] format, for example otlp or otlp/2. You can define components of a given type more than once as long as the identifiers are unique.

The inclusion of "/elastic" here may throw off users who are unfamiliar with this syntax, and trick them into thinking that they're dealing with some Elastic-specific variation of OTLP. We should remove the "/elastic".

@axw axw added the Team:Docs Label for the Observability docs team label Jul 3, 2024
@axw axw changed the title docs: docs: OpenTelemetry Collector example exporter config is misleading Jul 3, 2024
@graphaelli graphaelli self-assigned this Oct 17, 2024
@graphaelli
Copy link
Member

closed by elastic/observability-docs#4397

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants