Skip to content

Outdated pieces of documentation #13

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

Closed
bonclay7 opened this issue Jan 25, 2021 · 4 comments
Closed

Outdated pieces of documentation #13

bonclay7 opened this issue Jan 25, 2021 · 4 comments
Assignees

Comments

@bonclay7
Copy link
Member

Hello !

Thanks for the great documentation to get started with Open Telemetry on AWS. However I've noticed few bits of the documentation being slightly outdated.

Go context missing
The first example is missing context.Context as the first argument. https://aws-otel.github.io/docs/getting-started/go-sdk#installation-and-configuration

// Create new OTLP Exporter
exporter, err := otlp.NewExporter(
    otlp.WithTLSCredentials(creds), 
    otlp.WithAddress(<INSERT LISTEN ADDRESS HERE>),
)

Packages path

The ECS, and EKS detectors in the sections here and here are using a package which has been moved from:

  • go.opentelemetry.io/contrib/detectors/ecs to I believe go.opentelemetry.io/contrib/detectors/aws/ecs
  • go.opentelemetry.io/contrib/detectors/eks to I believe go.opentelemetry.io/contrib/detectors/aws/eks

Thanks

@bonclay7
Copy link
Member Author

Actually, with go.opentelemetry.io/otel/exporters/otlp v0.16.0 the NewExporter signature becomes different

@anuraaga
Copy link
Contributor

Thanks @bonclay7 - I am wording on updating our integration test app here and will then apply to the docs, sorry for the delay.

#10

@bhautikpip
Copy link
Contributor

documentation fixes here: aws-otel/aws-otel.github.io#81

@bonclay7
Copy link
Member Author

Awesome thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants