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: README refresh and docs update #157

Merged
merged 5 commits into from
Apr 30, 2024
Merged

docs: README refresh and docs update #157

merged 5 commits into from
Apr 30, 2024

Conversation

trentm
Copy link
Member

@trentm trentm commented Apr 30, 2024

Refs: #152

@trentm trentm requested a review from david-luna April 30, 2024 01:40
@trentm trentm self-assigned this Apr 30, 2024

### Elastic Observability endpoint
# 2. configure via OTEL_ envvars, for example:
export OTEL_EXPORTER_OTLP_ENDPOINT=https://{your-otlp-endpoint.example.com}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here we are using the generic term oltp endpoint but next line we refer to elastic secret token which is more concrete to our stack. I wonder if we should add a note here telling APM server is an OTLP endpoint also

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll change the example here to this:


# 1. install
npm install --save @elastic/opentelemetry-node

# 2. configure via OTEL_ envvars, for example:
export OTEL_EXPORTER_OTLP_ENDPOINT=https://{your-otlp-endpoint.example.com}
export OTEL_EXPORTER_OTLP_HEADERS="Authorization={authorization-information}"
export OTEL_SERVICE_NAME=my-service

# 3. start
node -r @elastic/opentelemetry-node my-service.js

If using an Elastic Observability deployment
to which to send telemetry data, the OTEL_EXPORTER_* settings will look
something like:

export OTEL_EXPORTER_OTLP_ENDPOINT=https://{deployment-name}.apm.{cloud-region}.cloud.es.io
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer {deployment-secret-token}"

@trentm trentm merged commit b7103d5 into main Apr 30, 2024
11 checks passed
@trentm trentm deleted the trentm/readme-refresh branch April 30, 2024 17:14
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

Successfully merging this pull request may close these issues.

2 participants