New Relic Nozzle for PCF
This documentation describes New Relic Nozzle for Pivotal Cloud Foundry (PCF).
New Relic Nozzle for PCF collects metrics and events that are generated by all PCF components and applications that run on PCF Diego cells via the Loggregator Firehose. It pushes this data to New Relic to be ingested by New Relic Insights for dashboarding and visualization.
Once you install New Relic Nozzle for PCF, it starts collecting and pushing Firehose events to New Relic Insights for visualization. New Relic organizes the Firehose data based on Firehose event types, and shows each Firehose event type in its own separate dashboard.
The nozzle can be installed as a tile in Ops Manager, or deployed using the CLI command cf push as a regular application. You can then monitor the health and performance of your PCF deployments, and set alerts based on any metrics that are collected from PCF Firehose.
You can filter the nozzle dashboards that allow you to visualize the Firehose metrics and events.
You can monitor the health and performance of PCF components with the following categories: * PCF Domain * PCF Deployment * Firehose Event Type * Origin * Job * Component IP Address * Application ID * Container
Select the item from a list of values for any of the above metrics and filter the dashboard based on the selected value. You can filter a dashboard by multiple metrics.
Due to a large number of events being streamed from the Firehose, in some cases you may want to set filtering to avoid ingestion of unwanted events in Insights. The nozzle allows you to filter out undesired events that are generated by the Firehose. In cases where there are events coming from a certain
job that are not vital to watch in your environment, you can tell the nozzle to exclude them. The nozzle provides exclusions and inclusions mechanism which you can set at global and/or event type levels. Currently, only ValueMetric events can be filtered.
If you need any of the Firehose event types (
"Error") to be captured by the nozzle and pushed to New Relic Insights, you must specify them as a comma-separated list of event types in the
"Selected Events" property in New Relic Firehose Nozzle tab of the tile configuration.
You can use
"Global Exclusions" in New Relic Firehose Nozzle Global Exclusion Filters tab to exclude a subset of the captured events based on the following event properties:
* Deployment name of events
* Job name of events
* Origin name of events
On top of the exclusions, you can still override them by specifying a subset of the excluded events to be included for
"ValueMetric" event types in New Relic Firehose Nozzle ValueMetric Inclusion Filters tab based on the following event properties:
* Deployment name of ValueMetric events
* Job name of ValueMetric events
* Origin name of ValueMetric events
* Metric name in the ValueMetric events
- If you exclude a particular
jobat the global level, but you include the same
"ValueMetric"level, it will be included in New Relic Insights.
- If you exclude a particular
jobat the global level, and include some
"ValueMetric"level, as long as the
originmatches the included origin, the event would be included, regardless of the
Note: When you run the nozzle as an application, you can use the above environment variables in the application manifest file.
Note: As of PCF v2.0, Elastic Runtime is renamed Pivotal Application Service (PAS).
The following table provides version and version-support information about New Relic Nozzle for PCF.
|Release date||July 27, 2018|
|Software component version||New Relic Nozzle v1.1.0|
|Compatible Ops Manager version(s)||v1.9.x, v1.10.x, v1.11.x, v1.12.x, v2.0.x, v2.1.x, and v2.2.x|
|Compatible Pivotal Application Service versions||v1.9.x, v1.10.x, v1.11.x, v1.12.x, v2.0.x, v2.1.x, and v2.2.x|
|IaaS support||AWS, GCP, Azure, and vSphere|
This project has been tested and is compatible with PCF versions v1.8 through v2.2.
New Relic Nozzle for PCF has the following requirements:
- An active New Relic account with a Pro or Pro Trial license
- New Relic Insights included in the license
If you do not already have a New Relic account, you can obtain a 60-day free trial license.
If you have a feature request, questions, or information about a bug, please submit an issue on github.