CloudBees Release Orchestration SaaS provides out of the box integration with NewRelic to provide the following features:
Send Pipeline execution events to NewRelic as custom events.
Verify deployment of application.
To enable the use of the above features in CloudBees Release Orchestration SaaS pipelines, a NewRelic instance must be configured in CloudBees Release Orchestration SaaS for secured access from the CloudBees Release Orchestration SaaS agent.
Steps to configure NewRelic with CloudBees Release Orchestration SaaS:
Login to CloudBees Release Orchestration SaaS portal with your username and password.
Click on the “Admin” tab
In the Settings screen, select “Observability”
In Observability settings, provide details shown below for secured access to NewRelic.
Select Tool Type as “NewRelic”
Enter Account Id
Enter User key and License key
On Saving the settings, the connection to NewRelic from the CloudBees Release Orchestration SaaS agent is verified. On successful verification of settings, it is available for use in CloudBees Release Orchestration SaaS pipelines.
NewRelic Custom Events:
In the CloudBees Release Orchestration SaaS Pipeline Composer screen, create New Pipeline or select the pipeline where you want to send custom events to the NewRelic tool.
Click the “Notification” check box, in which step information has to be sent as an event to NewRelic. Below are the steps you can configure to send events.
“Notify on” checkbox is to configure on which status event has to be sent.
Select mode as “Send event to observability tool”
Select NewRelic tool name configured in the observability settings page.
Save the pipeline.
Configure your NewRelic settings in the CloudBees Release Orchestration SaaS platform
Once you configure the settings, NewRelic tool name will be available under Send events to observability tool checkbox verification. You can configure notification events as shown in Figure 2.
Once a commit passes the event notification configured stage, information about the pipeline stage will be sent as an event to NewRelic. You can view events and create dashboards by running queries in NewRelic queryBuilder UI for RIQ Events eventType.
NewRelic Deployment Verification
In the CloudBees Release Orchestration SaaS Pipeline Composer screen, create New Pipeline or select the pipeline where you want to verify the deployments using the NewRelic tool.
Select Deployer step of the Pipeline, in the deployer options configuration panel click on the “Deployment Verification” check box to open the Deployment Verification popup window.
In the Deployment Verification popup window, select NewRelic in External Insights.
Then configure the following:
Select the duration for listening to Events. Varies from 1 min to a max of 24 Hours.
In Tool Name, select name of NewRelic settings previously configured
Select one or more policies available in NewRelic instance
Select one or more Conditions available in NewRelic instance
Optionally, select the checkbox to allow the pipeline to proceed on deployment failures.
Save the pipeline.
Explore how it works:
Configure your NewRelic settings in the CloudBees Release Orchestration SaaS platform, if not previously done.
Once you configure the settings click on the Deployment Verification check box, deployment verification popup will be opened.
Configure external insights configuration for NewRelic deployment verification as shown below.
Save the settings and update the pipeline.
During the Pipeline run, the NewRelic verification is automatically triggered immediately after deployment. NewRelic performs the verification as per the configuration in CloudBees Release Orchestration SaaS pipeline.
If Deployment Verification is successful, then a green color icon will appear at the bottom of Deploy Step.
When Deployment Verification is failed, then a red color icon will appear at the bottom of Deploy Step indicating that there are some critical violations that occurred in the configured policies within a given duration.
When we click on the failed Deployment verification icon, we can view Deployment Verification Results.
On completion of NewRelic deployment verification, the pipeline proceeds or fails based on the deployment verification configuration and results.
New Relic Dashboard Included
As our integration posts information back to New Relic on the Deployments, we have created this Dashboard in the Quickstart.
You can explore more about New Relic integration with CloudBees Release Orchestration SaaS by Clicking here