framework-metric_writer.md

Metric Writer Framework

The Metric Writer Framework causes an application to be automatically configured to work with a bound Metrics Forwarder Service.

Detection Criterion	Existence of a single bound Metrics Forwarder service. Existence of a Metrics Forwarder service is defined as the VCAP_SERVICES payload containing a service who's name, label or tag has metrics-forwarder as a substring.
Tags	metric_writer=<version>

Tags are printed to standard output by the buildpack detect script

The credential payload of the service may contain the following entries:

Name	Description
access_key	The access key used to authenticate agains the endpoint
endpoint	The endpoint

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.

The framework can be configured by modifying the config/metric_writer.yml file in the buildpack fork. The framework uses the Repository utility support and so it supports the version syntax defined there.

Name	Description
repository_root	The URL of the Metric Writer repository index (details).
version	The version of Metric Writer to use. Candidate versions can be found in this listing.