Name: loggregator-api
Owner: Cloud Foundry
Description: null
Created: 2017-01-10 17:14:52.0
Updated: 2017-12-01 22:14:52.0
Pushed: 2018-02-16 22:58:12.0
Size: 37
Language: null
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This is the v2 API for Loggregator.
| Field | Description |
|————-|———————————————————————————————————————————|
| timestamp | UNIX timestamp in nanoseconds. |
| source_id | The source's ID of an envelope. (e.g., 984992f6-3cfb-4417-9321-786ee5233e9c for an app or cf/doppler for a doppler) |
| instance_id | The instance of a particular source (e.g., 1 for an app or ede37607-52f0-4154-bb1b-4ae35212e126 for a doppler) |
| tags | key/value tags to include additional identifying information. (e.g. deployment=cf-warden) |
The meaning of source_id and instance_id depend on the context of their
usage. There is either a Bosh-deployed instance group or a CF-pushed
application. In the case of an instance group, source_id refers to a job
name, e.g., Doppler, and instance_id refers to the particular instance
guid. In the case of a CF application, the source_id refers to the app guid,
and the instance_id refers to the instance number of the application.
A Log is used to represent a simple text payload.
It represents whether the log is emitted to STDOUT or STDERR.
A Counter is used to represent a metric that only increases in value (e.g.
metron.sentEnvelopes).
The emitter of a counter must set the delta (anything else will be
discarded). It also provides the sum of all emitted values.
A Gauge is used to represent a metric that can have arbitary numeric values that 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})
A Timer is used to represent a metric that captures the duration of an
event. (e.g. databasePost)
An Event 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 the following mappings:
Note previous versions of the Loggregator API automatically added tags to
envelopes for things like deployment, job, and index. This functionality
has been removed in the v2 API. Users should manually add whatever tags they
require.
| v1 | v2 | |————|———————————-| | timestamp | envelope.timestamp | | tags | envelope.tags | | origin | envelope.tags['origin'].text | | deployment | envelope.tags['deployment'].text | | job | envelope.tags['job'].text | | index | envelope.tags['index'].text | | ip | envelope.tags['ip'].text |
An HttpStartStop envelope is derived from a v2 Timer envelope.
| v1 | v2 | |—————-|—————————————–| | startTimestamp | timer.start | | stopTimestamp | timer.stop | | applicationId | envelope.source_id | | requestId | envelope.tags['request_id'].text | | peerType | envelope.tags['peer_type'].text | | method | envelope.tags['method'].text | | uri | envelope.tags['uri'].text | | remoteAddress | envelope.tags['remote_address'].text | | userAgent | envelope.tags['user_agent'].text | | statusCode | envelope.tags['status_code'].integer | | contentLength | envelope.tags['content_length'].integer | | instanceIndex | envelope.tags['instance_index'].integer | | forwarded | envelope.tags['forwarded'].text |
A LogMessage envelope is derived from a v2 Log envelope
| v1 | v2 | |—————–|—————————————| | message | log.payload | | message_type | log.type | | timestamp | envelope.timestamp | | app_id | envelope.source_id | | source_type | envelope.tags['source_type'].text | | source_instance | envelope.instance_id |
A CounterEvent envelope is dervied from a v2 Counter envelope
| v1 | v2 | |——-|—————| | name | counter.name | | delta | - | | total | counter.total |
A ValueMetric envelope is dervied from a v2 Gauge envelope. Each gauge value in a Gauge envelope will become a single ValueMetric envelope.
| v1 | v2 | |——-|——————————–| | name | first-key | | value | gauge.metrics[first-key].value | | unit | gauge.metrics[first-key].unit |
A ContainerMetric envelope is dervied from a v2 Gauge envelope if and only if there are the correct gauge keys.
| v1 | v2 | |——————|—————————————| | applicationId | envelope.source_id | | instanceIndex | envelope.instance_id | | cpuPercentage | gauge.metrics['cpu'].value | | memoryBytes | gauge.metrics['memory'].value | | diskBytes | gauge.metrics['disk'].value | | memoryBytesQuota | gauge.metrics['memory_quota'].value | | diskBytesQuota | gauge.metrics['disk_quota'].value |
go-loggregator is a client library that consumes the v2 API to make it easier to create a client and connect to Loggregator to obtain logs and metrics.