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

chore: Add instructions for user API key #10328

Merged
merged 2 commits into from
Nov 15, 2022
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ To assign an application name:

This will assign instances in the given environment the label given by `app_name` when browsing your data in the New Relic user interface. The deployment upload script will use that label to associate an app with the deployment.

## Add your user key [#api-key]

Optionally, you can record deployments via the New Relic REST API v2. To do this, provide your [user key](/docs/apis/intro-apis/new-relic-api-keys/#overview-keys) to the agent configuration using `api_key`. When this configuration is present, the `newrelic deployments` command automatically uses the REST API v2 deployment endpoint.

## Record with the command line [#Manual]

If you installed the Ruby agent as a gem, you can record deployments directly by using the `newrelic` executable:
Expand All @@ -44,6 +48,8 @@ You can use several optional values with `newrelic`. The `description` is short
deployments [OPTIONS] [description]
OPTIONS:
-a, --appname=name Set the application name.
-i, --appid=ID Set the application ID
If not provided, will connect to the New Relic collector to get it
Default is app_name setting in newrelic.yml
-e, --environment=name Override the (RAILS|RUBY)_ENV setting
-u, --user=USER Specify the user deploying.
Expand Down