community.general.newrelic_deployment module – Notify newrelic about app deployments
Note
This module is part of the community.general collection (version 4.8.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.newrelic_deployment
.
Synopsis
Notify newrelic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/deployment-notifications#api)
Parameters
Parameter |
Comments |
---|---|
(one of app_name or application_id are required) The value of app_name in the newrelic.yml file used by the application |
|
(one of app_name or application_id are required) The application id, found in the URL when viewing the application in RPM |
|
Name of the application |
|
A list of changes for this deployment |
|
Text annotation for the deployment - notes for you |
|
The environment for this deployment |
|
A revision number (e.g., git commit SHA) |
|
API token, to place in the x-api-key header. |
|
The name of the user/process that triggered this deployment |
|
If Choices:
|
Examples
- name: Notify newrelic about an app deployment
community.general.newrelic_deployment:
token: AAAAAA
app_name: myapp
user: ansible deployment
revision: '1.0'
Authors
Matt Coddington (@mcodd)
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication