Set Sentry tags #637
Merged
Set Sentry tags #637
Conversation
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
matthew-white
commented
Oct 10, 2022
| @@ -133,6 +133,11 @@ const init = (config) => { | |||
| const username = require('os').hostname(); | |||
| Sentry.setUser({ username }); | |||
|
|
|||
| if (isPresent(process.env.SENTRY_TAGS)) { | |||
There was a problem hiding this comment.
SENTRY_TAGS won't typically be present during local development.
Together with getodk/central#317, closes #547.
matthew-white
force-pushed
the
sentry-tags
branch
from
3ef0593
to
2eff3bd
Compare
matthew-white
commented
Oct 10, 2022
| @@ -133,6 +133,12 @@ const init = (config) => { | |||
| const username = require('os').hostname(); | |||
| Sentry.setUser({ username }); | |||
|
|
|||
| if (isPresent(process.env.SENTRY_TAGS)) { | |||
| const tags = JSON.parse(process.env.SENTRY_TAGS); | |||
There was a problem hiding this comment.
At getodk/central#317 (comment), I was thinking of wrapping the JSON.parse() in a try/catch. However, I've ended up thinking that that'd be premature. We don't expose SENTRY_TAGS to users. And if there's a problem with SENTRY_TAGS, that would indicate a bug that we'd want to know about.
alxndrsn
approved these changes
Oct 11, 2022
|
I deployed this PR to the QA server. Version information isn't coming through, but I'm pretty sure it's an issue with getodk/central#317, not this PR. I'll merge this PR, then file an issue on |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR sets Sentry tags that are specified in an environment variable named
SENTRY_TAGS. The approach is generic — any sort of tags could be set — but it was developed as part of getodk/central#317 in order to pass Central version information to Sentry. Together with getodk/central#317, this PR closes #547.What has been done to verify that this works as intended?
Nothing yet. Once this PR has been merged, I'll verify it on the QA server.
Why is this the best possible solution? Were any other approaches considered?
We discussed this broad strategy in getodk/central#317.
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
This change only touches Sentry. When I verify this change, that'll also verify that Sentry is still working.
Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.
No change needed.
Before submitting this PR, please make sure you have:
make test-fulland confirmed all checks still pass OR confirm CircleCI build passes