-
Notifications
You must be signed in to change notification settings - Fork 8
/
index.html.md.erb
111 lines (80 loc) · 5.13 KB
/
index.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
---
title: New Relic Nozzle for VMware Tanzu
owner: Partners
---
<br/>
[New Relic Nozzle for VMware Tanzu](https://network.pivotal.io/products/nr-firehose-nozzle/) collects metrics and events generated by all VMware Tanzu components and applications that run on VMware Tanzu Diego cells via the [Loggregator Firehose](https://docs.pivotal.io/pivotalcf/loggregator/index.html). The nozzle collects data via the Remote Log Proxy (RLP) gateway and pushes it to [New Relic](https://www.newrelic.com) for processing and visualization.
<br/>
<center>
<img src="images/newrelic-nozzle-tile.png" alt="New Relic Nozzle Tile" height="150" width="150"/>
</center>
## <a id='overview'></a> Overview
After installation, the nozzle starts collecting and pushing Firehose events to New Relic for processing and visualization. New Relic organizes the 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 VMware Tanzu deployments, and set alerts based on any metrics that are collected from VMware Tanzu Firehose.
## <a id='features'></a> Key Features
You can monitor health and performance data of VMware Tanzu components, including:
* VMware Tanzu Domain
* VMware Tanzu Deployment
* Firehose Event Type
* Origin
* Job
* Component IP Address
* Application Detail
* 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 also filter a dashboard by multiple metrics.
## <a id='filters'></a> Event Filtering
When a large number of events is streamed from the Firehose, you may want to filter out undesired events that are generated by the Firehose.
If you need any of the Firehose event types (`ValueMetric`, `CounterEvent`, `ContainerMetric`, `HttpStartStop`, `LogMessage`) 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, located in the **Advanced Settings** tab of the tile settings.
Starting with version 2.X of the nozzle, `ContainerMetric`, `CounterEvent`, and `ValueMetric` events are aggregated. Events include the `min`, `max`, `sum`, `sample count`, and `last` value of each metric. This reduces the number of events created by the nozzle while still providing detail on each metric type.
If needed, configure **LogMessage Filters** to include or exclude subsets of LogMessage events.
### <a id='filter-examples'></a> Filter Examples
* **LogMessage Source Include Filter**: Only generate events for log messages with a source listed in this comma or pipe-separated list.
* **LogMessage Source Exclude Filter**: Do not generate events for log messages with a source listed in this comma or pipe-separated list.
* **LogMessage Message Include Filter**: Only generate events for log messages that contain text listed in this comma or pipe-separated list.
* **LogMessage Message Exclude Filter**: Do not generate events for log messages that contain text listed in this comma or pipe-separated list.
Multiple LogMessage filters can be combined to limit event creation. Include filters are processed before exclude filters.
<p class='note'><strong>Note:</strong> When you run the nozzle as an application, you can use the above environment variables in the application manifest file.</p>
## <a id="snapshot"></a> Product Snapshot
The following table provides version and version-support information about New Relic Nozzle for VMware Tanzu.
<table class="nice">
<th>Element</th>
<th>Details</th>
<tr>
<td>Tile version</td>
<td>2.8.0</td>
</tr>
<tr>
<td>Release date</td>
<td>September 1, 2023</td>
</tr>
<tr>
<td>Software component version</td>
<td>New Relic Nozzle v2.8.0</td>
</tr>
<tr>
<td>Compatible Ops Manager version(s)</td>
<td>v2.9.x, v2.10.x and v3.0.x</td>
</tr>
<tr>
<td>Compatible VMware Tanzu Application Service for VMs versions</td>
<td>v2.10.x, v2.11.x, v2.12.x, v2.13.x, v3.0.x and v4.0.x</td>
</tr>
<tr>
<td>BOSH stemcell version</td>
<td>Ubuntu Jammy</td>
</tr>
<tr>
<td>IaaS support</td>
<td>AWS, GCP, Azure, and vSphere</td>
</tr>
</table>
## <a id='compatibility'></a> Compatibility
This project is compatible with VMware Tanzu versions v2.10.x through v4.0.x.
## <a id="reqs"></a> Requirements
New Relic Nozzle for VMware Tanzu has the following requirements:
* An active New Relic account with a Pro or Pro Trial license
* New Relic Insights included in the license
## <a id='trial'></a> Trial License
If you do not already have a New Relic account, you can obtain a [14-day free trial license](http://newrelic.com/signup?funnel=pivotal-cloud-foundry&partner=Pivotal+Cloud+Foundry).
## <a id="feedback"></a> Feedback
If you have a feature request, questions, or information about a bug, please submit an issue [on github](https://github.com/newrelic/newrelic-pcf-nozzle-tile/issues).