Metrics for Monitoring an On-Demand Broker

This topic describes the metrics that the on-demand broker generates. For general information about logging and metrics in Pivotal Cloud Foundry (PCF), see Overview of Logging and Metrics.

About On-Demand Broker Metrics

Enabling Metrics: The on-demand broker only emits metrics when deployed with Service Metrics. For more information, see the Deploying a Release with Service Metrics in the Service Metrics documentation.

Metrics Format: Metrics are regularly-generated log messages that report measured component states. They are formatted as long, single lines of text, for example:

origin:"BROKER-DEPLOYMENT-NAME" eventType:ValueMetric timestamp:1560950924586744417 deployment:"BROKER-DEPLOYMENT-NAME" job:"broker" index:"0" ip:"BROKER-IP-ADDRESS" tags:<key:"source_id" value:"broker"> valueMetric:<name:"/on-demand-broker/BROKER-DEPLOYMENT-NAME/total_instances" value:10 unit:"count">

On-Demand Broker Metrics

The following sections describe the metrics used for monitoring the on-demand broker.

Global Service Instance Count


/on-demand-broker/SERVICE-NAME/total_instances

Description Use: This is the global total number of instances created by the broker.

Origin: Doppler/Firehose
Type: count
Alert thresholds This threshold applies if service instance quotas are configured. For instructions, see (Optional) Set Service Instance Quotas.

Warning: > quota * 0.8
Critical: > quota * 0.95
Recommended response Delete any unused service instances, or increase the global service instance limit.

Service Instance Count Per Plan


/on-demand-broker/SERVICE-NAME/PLAN-NAME/total_instances

Description Use: This is the total number of instances created by the broker for a given plan.

Origin: Doppler/Firehose
Type: count
Alert thresholds This threshold applies if service instance quotas are configured. For instructions, see (Optional) Set Service Instance Quotas.

Warning: > quota * 0.8
Critical: > quota * 0.95
Recommended response Delete any unused service instances, select a different plan, or increase the service instance limit for the given plan.

Global Resource Quota


/on-demand-broker/SERVICE-NAME/RESOURCE-TYPE/used

/on-demand-broker/SERVICE-NAME/RESOURCE-TYPE/remaining

Description Use: These two metrics combine to give a picture of global resource quota usage for instances created by the broker.

Origin: Doppler/Firehose
Type: count
Alert thresholds This threshold applies if service instance resource quotas are configured. For instructions, see (Optional) Set Resource Quotas.

Warning: > quota * 0.8
Critical: > quota * 0.95
Recommended response Delete any unused service instances, or increase the global quota for this resource.

Resource Quota Per Plan


/on-demand-broker/SERVICE-NAME/PLAN-NAME/RESOURCE-TYPE/used

/on-demand-broker/SERVICE-NAME/PLAN-NAME/RESOURCE-TYPE/remaining

Description Use: These two metrics combine to give a picture of resource quota usage for instances created by the broker for a given plan.

Origin: Doppler/Firehose
Type: count
Alert thresholds This threshold applies if service instance resource quotas are configured. For instructions, see (Optional) Set Resource Quotas.

Warning: > quota * 0.8
Critical: > quota * 0.95
Recommended response Delete any unused service instances, select a different plan, or increase the quota for this resource for the given plan.