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.

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

chore: add environment variables section for OTLP #185

Merged
merged 3 commits into from
Feb 23, 2024
Merged

chore: add environment variables section for OTLP #185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e971e29
chore: add environment variables section for OTLP
yquansah Feb 13, 2024
8cc29d8
chore: revamp env var section
markphelps Feb 23, 2024
49f1f68
Merge branch 'main' into otlp-env-vars
markphelps Feb 23, 2024
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
9 changes: 9 additions & 0 deletions configuration/observability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,12 @@
headers:
"X-Some-Header": "some-value"
```

#### Environment Variables

Check warning on line 114 in configuration/observability.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Environment Variables' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Environment Variables' should be in sentence case", "location": {"path": "configuration/observability.mdx", "range": {"start": {"line": 114, "column": 6}}}, "severity": "WARNING"}

As of [v1.38.0](https://github.com/flipt-io/flipt/releases/tag/v1.38.0), we now allow users to provide OTLP specific resource environment variables that are part of the [OTLP spec](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/).

Check warning on line 116 in configuration/observability.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "configuration/observability.mdx", "range": {"start": {"line": 116, "column": 74}}}, "severity": "WARNING"}

The following environment variables are supported:

- `OTEL_SERVICE_NAME` - Sets the value of the `service.name` resource attribute (default: `flipt`)
- `OTEL_RESOURCE_ATTRIBUTES` - Key-value pairs to be used as [resource attributes](https://opentelemetry.io/docs/specs/semconv/resource/#semantic-attributes-with-dedicated-environment-variable).
Loading