LATEST VERSION: 1.11 - CHANGELOG
Metrics Forwarder for PCF v1.11

Consuming Metrics from Firehose

This topic describes how users can consume their custom app metrics from the Loggregator Firehose.

Credentials

Users must have the doppler.firehose scope to read data from the Firehose. See Scopes for a description of the scopes covered by UAA.

Connecting to the Firehose

You can read metrics from the Firehose using a Firehose consumer of your choice, including community and third-party nozzles.

Reading Metrics

Metrics Forwarder for PCF sends all metrics to Loggregator as ValueMetrics. It also specifies the type of each metric: gauge or counter.

All metrics emitted by apps through Metrics Forwarder for PCF have the following Dropsonde envelope attributes.

Attribute Metrics Forwarder API Data Description
job metrics_forwarder Name of the Metrics Forwarder job.
origin metrics-forwarder Origin of Metrics Forwarder.
tags See the tags table below. Metrics Forwarder-provided and user-defined key and value pairs to include additional identifying information.
valueMetric See the valueMetric table below. Key and value pairs that include the name, value, and unit of the metric. The values are emitted to the API in the metrics entity of the JSON body.

The table below lists the key and value pairs provided in the tags attribute of the above Dropsonde envelope.

Key Metrics Forwarder API Data Description
applicationGuid applications.id App ID emitted to the API in the applications entity of the JSON body.
applicationInstance applications.instances.id Instance ID emitted to the API in the instances entity of the JSON body.
applicationInstanceIndex applications.instances.index Instance index emitted to the API in the instances entity of the JSON body.
type applications.instances.metrics.type Metric type emitted to the API in the metrics entity of the JSON body.
User-defined tags applications.instances.metrics.tags User-defined tags emitted to the API in the metrics entity of the JSON body.

The table below lists the key and value pairs provided in the valueMetric attribute of the above Dropsonde envelope.

Key Metrics Forwarder API Data Description
name applications.instances.metrics.name Metric name emitted to the API in the metrics entity of the JSON body.
unit applications.instances.metrics.unit Metric unit emitted to the API in the metrics entity of the JSON body.
value applications.instances.metrics.value Metric value emitted to the API in the metrics entity of the JSON body.

For more information about the Metrics Forwarder API, see the Metrics Forwarder API documentation.

Create a pull request or raise an issue on the source for this page in GitHub