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

Add Errors Inbox metadata configuration content to generated doc #2704

Open
kaylareopelle opened this issue Jun 10, 2024 · 3 comments
Open

Comments

@kaylareopelle
Copy link
Contributor

kaylareopelle commented Jun 10, 2024

The Errors Inbox team would like the Ruby agent's configuration document to include the following:

## Errors inbox configuration [#errors-inbox-configuration]

Setting one of the following environment variables will help you identify which versions of your software are producing the errors. 

* `NEW_RELIC_METADATA_SERVICE_VERSION` will create tags.service.version on event data containing the version of your code that is deployed, in many cases a semantic version such as 1.2.3, but not always.
* `NEW_RELIC_METADATA_RELEASE_TAG ` will create tags.releaseTag on event data containing the release tag (such as v0.1.209 or release-209).  
* `NEW_RELIC_METADATA_COMMIT` will create tags.commit on event data containing the commit sha. The entire sha can be used or just the first seven characters (e.g., 734713b). 

[Errors inbox](https://docs.newrelic.com/docs/errors-inbox/version-tracking/) will automatically track which versions of your software are producing errors. Any version data will also be displayed in [CodeStream](/docs/codestream/how-use-codestream/performance-monitoring/#buildsha). 

These features have been verified to work on a Rails 7 application: (permalink/internal)

This documentation was manually added to our configuration doc, and overridden by our generator.

Our current generator uses the configs defined in our lib/new_relic/agent/configuration/default_source.rb file to generate sections. These configs are not defined in our default_source.rb file. Consider whether we want to add them to default_source.rb or add this section in another way.

@workato-integration
Copy link

@meda123
Copy link

meda123 commented Jun 10, 2024

@kaylareopelle - Thanks so much for adding this to your docs. Could we change "An upcoming release of errors inbox" to "Errors inbox will automatically..." because we've already launched the version tracking update :), it's no longer an upcoming release.

@kaylareopelle
Copy link
Contributor Author

@meda123, great catch! I updated the text in the description to include your edit. 🙂

I also updated tags to environment variables in the sentence, Setting one of the following environment variables...

Does that work for you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants