https://github.com/jenkinsci/newrelic-deployment-notifier-plugin

Jenkins plugin to notify New Relic about deployments
https://github.com/jenkinsci/newrelic-deployment-notifier-plugin

deployment newrelic notifier

Last synced: 4 months ago
JSON representation

Jenkins plugin to notify New Relic about deployments

• Host: GitHub
• URL: https://github.com/jenkinsci/newrelic-deployment-notifier-plugin
• Owner: jenkinsci
• License: mit
• Created: 2015-03-09T13:38:12.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-09T09:18:19.000Z (6 months ago)
• Last Synced: 2024-09-30T08:57:48.129Z (4 months ago)
• Topics: deployment, newrelic, notifier
• Language: Java
• Homepage: https://plugins.jenkins.io/newrelic-deployment-notifier/
• Size: 175 KB
• Stars: 8
• Watchers: 103
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
Jenkins New Relic Deployment Notifier Plugin

============================================

Jenkins plugin to notify New Relic about [deployments][].

## Requirements

* An account at **[New Relic][]**

* API access enabled by creating an **[API key][]**

* **Jenkins 1.580.1** or newer

## Usage

Use the New Relic Deployment Notifier by adding it as a *Post Step* in

you Jenkins build job configuration.

1.  In your Jenkins job configuration go to the **Post-build Actions**

    section, click on **Add post-build action** and select **New Relic

    Deployment Notifications**

    ![](docs/images/postbuild.png)

2.  Create a username/password credential for the API key. Enter the

    key as the password.

    ![](docs/images/credential.png)

3.  Select an application in the dropdown list.

    ![](docs/images/validcredential.png)

4.  Add any of the optional values: *description*, *revision*,

    *changelog* or *user*

    ![](docs/images/optional.png)

If you have configured everything correctly, Jenkins will notify you New

Relic account of subsequent deployments.

It is possible to configure several applications to be notified.

![](docs/images/addnotification.png)

### Getting user as an environment variable

Install the [Build User Vars

Plugin](https://wiki.jenkins.io/display/JENKINS/Build+User+Vars+Plugin)

and use any of the supported environment variables.

![](docs/images/user.png)

## Maintainers

* Jonathan Gordon

* Justin Lewis

* Mads Mohr Christensen

## Changelog

[Changelog](CHANGELOG.md)

## License

	(The MIT License)

	Copyright (c) 2015, Mads Mohr Christensen

	Permission is hereby granted, free of charge, to any person obtaining

	a copy of this software and associated documentation files (the

	'Software'), to deal in the Software without restriction, including

	without limitation the rights to use, copy, modify, merge, publish,

	distribute, sublicense, and/or sell copies of the Software, and to

	permit persons to whom the Software is furnished to do so, subject to

	the following conditions:

	The above copyright notice and this permission notice shall be

	included in all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

	MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

	IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

	CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

	TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

	SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[deployments]: https://docs.newrelic.com/docs/change-tracking/change-tracking-view-analyze/

[New Relic]: http://newrelic.com/

[API key]: https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/