-
-
Notifications
You must be signed in to change notification settings - Fork 7
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
rfc(decision): Environment Variable conventions #121
Open
cleptric
wants to merge
4
commits into
main
Choose a base branch
from
rfc/draft-environment-variable-conventions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+48
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
- Start Date: 2023-11-07 | ||
- RFC Type: decision | ||
- RFC PR: https://github.com/getsentry/rfcs/pull/121 | ||
- RFC Status: draft | ||
|
||
# Summary | ||
|
||
We already expose certain environment variables that are consumed by SDKs, such as `SENTRY_DSN` and `SENTRY_RELEASE`. | ||
To further ease usage, we should expose more options as such. | ||
This RFC aims to find a set of conventions mainly aimed for server-side SDKs. | ||
|
||
# Motivation | ||
|
||
Changing the SDK configuration most often requires a re-deployment of the application. This can be cumbersome for small changes, | ||
such as updating the `traces_sample_rate`. Given the rise in populairty of server-less or containerized deployments, where | ||
most configuration hails from envrionment variables, we should strive to make this workflow less cumbersome for our users. | ||
|
||
# Background | ||
|
||
The Laravel SDK exposes the majority of its configuration as environment variables, making it a breeze to update the configuration of the SDK easily. | ||
For a complete list of exposed variables, see https://github.com/getsentry/sentry-laravel/blob/9624a88c9cd9a50c22443fcdf3a0f77634b11210/config/sentry.php | ||
|
||
# Options Considered | ||
|
||
A first list of environment variables that all server sides SDKs should support could look like: | ||
|
||
- `SENTRY_DSN` | ||
- `SENTRY_RELEASE` | ||
- `SENTRY_ENVIRONMENT` | ||
- `SENTRY_SAMPLE_RATE` | ||
- `SENTRY_TRACES_SAMPLE_RATE` | ||
- `SENTRY_PROFILES_SAMPLE_RATE` | ||
- `SENTRY_DEBUG` | ||
|
||
cleptric marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Further additions could include but are not limited to: | ||
|
||
- `SENTRY_TAGS_<tag-key>` - An environment variable of `SENTRY_TAGS_foo = "bar"` would result in a tag of `foo: bar` being attached to all events. | ||
|
||
or SDK/framework-specific options, such as to control integrations or features | ||
|
||
- `SENTRY_BREADCRUMBS_LOGS_ENABLED` | ||
- `SENTRY_TRACE_MISSING_ROUTES_ENABLED` | ||
|
||
# Drawbacks | ||
|
||
TBD |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just stumbled across this RFC. We could also list
SENTRY_TRACE
andSENTRY_BAGGAGE
, which could be picked up to continue traces.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, there is/was another RFC for that, but I can add it and actually move this RFC forward 😬