Skip to content

small fixes on the Managed ClickStack guide #6393

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.

Sign up for GitHub

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

Merged
gingerwizard merged 1 commit into from
Jun 15, 2026
+5 −5
Merged

small fixes on the Managed ClickStack guide #6393

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...se-cases/observability/clickstack/managed-onboarding/managed-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,18 +230,18 @@

The application needs two values to reach the collector you deployed above:

- `OTEL_EXPORTER_OTLP_ENDPOINT`: the OTLP endpoint your collector exposes (commonly port `4318` for OTLP over HTTP).
- `OTEL_EXPORTER_OTLP_HEADERS`: the authorization header carrying your ingestion token, in the form `authorization=<token>`. Use the `OTLP_AUTH_TOKEN` you set on the collector above, or whatever auth header your existing collector expects.
- `OTEL_EXPORTER_OTLP_ENDPOINT`: the OTLP endpoint your collector exposes (commonly port `4318` for OTLP over HTTPS).

Check notice on line 233 in docs/use-cases/observability/clickstack/managed-onboarding/managed-getting-started.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Uppercase 

Suggestion: Instead of uppercase for 'OTLP', use lowercase or backticks (`) if possible. Otherwise, ask a Technical Writer to add this word or acronym to the rule's exception list.

Check notice on line 233 in docs/use-cases/observability/clickstack/managed-onboarding/managed-getting-started.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Uppercase 

Suggestion: Instead of uppercase for 'OTLP', use lowercase or backticks (`) if possible. Otherwise, ask a Technical Writer to add this word or acronym to the rule's exception list.
- `OTEL_EXPORTER_OTLP_HEADERS`: the authorization header carrying your ingestion token, in the form `authorization=<ingestion_token>`. Use the `OTLP_AUTH_TOKEN` you set on the collector above, or whatever auth header your existing collector expects.

Open `.env` and set them:
Copy `.env.example` to `.env`, then open the file and set the following variables:

```bash
OTEL_SERVICE_NAME=hn-analyzer-api
OTEL_EXPORTER_OTLP_ENDPOINT=https://<your-collector-endpoint>:4318
OTEL_EXPORTER_OTLP_HEADERS=authorization=<your-ingestion-token>
OTEL_EXPORTER_OTLP_HEADERS=authorization=<ingestion_token>
```

The SDK uses `OTEL_EXPORTER_OTLP_HEADERS` to set the authorization header for all three signals: traces, metrics, and logs. If your collector runs locally and doesn't enforce auth, you can leave the value empty (`OTEL_EXPORTER_OTLP_HEADERS=authorization=`), but the variable must be present; the SDK skips initialization entirely if it's unset or fully empty.
The SDK uses `OTEL_EXPORTER_OTLP_HEADERS` to set the authorization header for all three signals: traces, metrics, and logs. If your collector runs locally and doesn't enforce auth, you can leave the value empty (`OTEL_EXPORTER_OTLP_HEADERS=authorization=`), but the variable must be present; the SDK skips initialization entirely if it's unset or fully empty. Finally, when running the collector without TLS, ensure you use the correct HTTP protocol (ex: `http://localhost:4318`).

## Instrument the application {#instrument-the-application}

Expand Down
Loading