Skip to content

Commit

Permalink
Add instructions for user API key
Browse files Browse the repository at this point in the history
PR newrelic/newrelic-ruby-agent#1461 added support for deployment recording using a customer's user API key. This update was missing from the document.
  • Loading branch information
kaylareopelle authored Nov 15, 2022
1 parent bbd4643 commit 4915bed
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ 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 API key (Optional) [#Api-Key]

You can use the New Relic REST API v2 to record deployments by providing your user API key to the agent configuration using `api_key`.

When this configuration option is present, the `newrelic deployments` command will automatically use the New Relic 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 +50,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

0 comments on commit 4915bed

Please sign in to comment.