Repository files navigation

This is the v2 API forLoggregator.

If you have any questions, or want to get attention for a PR or issue please reach out on the#logging-and-metrics channel in the cloudfoundry slack

• v2 Envelope
• v2 Envelope Types
  • Log
  • Counter
  • Gauge
  • Timer
  • Event
• v2 -> v1 mapping
  • Envelope
  • HttpStartStop
  • LogMessage
  • CounterEvent
  • ValueMetric
  • ContainerMetric
• Client Library

The meaning ofsource_id andinstance_id depend on the context of theirusage. There is either a Bosh-deployed instance group or a CF-pushedapplication. In the case of an instance group,source_id refers to a jobname, e.g., Doppler, andinstance_id refers to the particular instanceguid. In the case of a CF application, thesource_id refers to the app guid,and theinstance_id refers to the instance number of the application.

ALog is used to represent a simple text payload.

It represents whether the log is emitted to STDOUT or STDERR.

ACounter is used to represent a metric that only increases in value (e.g.metron.sentEnvelopes).

The emitter of a counter must set thedelta (anything else will bediscarded). It also provides the sum of all emitted values.

AGauge is used to represent a metric that can have arbitary numeric valuesthat increase or decrease.

It can be used emit a set of relatable metrics (e.g.memory{value=2048, unit=byte}, disk{value=4096, unit=byte}, cpu{value=2, unit=percentage})

ATimer is used to represent a metric that captures the duration of anevent. (e.g.databasePost)

AnEvent is used to represent data related to an asynchronous event that occured.

The properties in a v1 envelope can be obtained from a v2 envelope using thefollowing mappings:

Note previous versions of the Loggregator API automatically added tags toenvelopes for things likedeployment,job, andindex. This functionalityhas been removed in the v2 API. Users should manually add whatever tags theyrequire.

When envelopes went from the v1 to the v2 format, tags changed from a typed format, to being strings in all cases. When recieving envelopes from V2, to get the string formatted tagsUsePreferredTags should be used on the egress request. If this flag is not used, the v1 tags will be stored indeprecated_tags rather thentags, and will be formatted asloggregator_v2.Value rather then strings. You should not use this tag if you want to use the v1 conversion function.

AnHttpStartStop envelope is derived from a v2Timer envelope.

ALogMessage envelope is derived from a v2Log envelope

ACounterEvent envelope is derived from a v2Counter envelope

One or moreValueMetric envelopes are derived from a v2Gauge envelope. Eachmetric key/value in aGauge envelope will become a singleValueMetricenvelope.

AContainerMetric envelope is derived from a v2Gauge envelope if and onlyif there are the correct gauge keys.

go-loggregator is a client library that consumes the v2 APIto make it easier to create a client and connect to Loggregator to obtain logsand metrics.