Loggregator Tools

Big Logger

Sends big logs. Allows user to pass in size, frequency, and receiver port as arguments.

CF LogMon

The CF LogMon performs a blacbox test for measuring message reliability when running the command cf logs. This is accomplished by writing groups of logs, measuring the time it took to produce the logs, and then counting the logs received in the log stream. This is one way to measure message reliability of the Loggregator system. The results of this test are displayed in a simple UI and available via JSON and the Firehose.

Counter

Web-based counter API used by the Smoke Tests.

Datadog Accumulator

The Datadog Accumulator scrapes Gauge values for a given source-id and send the results to Datadog.

Doppler Client

The Doppler Client will connect to the V2 egress API of the Doppler and read all the logs/metrics from that single Doppler.

The Doppler Client application must be configured with DATADOG_API_KEY and DOPPLER_ADDR, SHARD_ID, CA_PATH, CERT_PATH, KEY_PATH environment variables.

Dummy Metron

A NOOP metron (loggregator agent).

Echo

Contains an HTTP and TCP echo server. Both of which will simply print whatever they receive.

Emitter

Emits a V2 Counter Envelope to the Loggregator Agent at a one second interval.

Envelope Emitter

Emits a V2 Gauge Envelope to the Loggregator Agent at a one second interval.

HTTPS Drain

The HTTPS Drain is an example HTTPS server that accepts syslog messages (RFC-5424). This is a useful tool for debugging and monitoring cf-syslog-drain-release. The HTTPS drain can be configured to POST a counter.

JSON Spinner

JSON Spinner is a sample CF application that is written in go. It is compatible with the go-buildpack. It is used by the cf-syslog-drain black box tests.

Latency

Measures the latency from when an application running on CF emits a log to the time that log is egressed via the V1 app stream.

Log Spinner

Log Spinner is a sample CF application that is written in go. It is compatible with the go-buildpack.

Post Printer

The post printer is a CF application that prints every request to stderr.

Reliability

Reliability is a tool for measuring the Loggregator Firehose. It consists of two parts, a server and a worker. You should deploy the same number of workers as you have Traffic Controllers. The server will communicate with the workers via WebSockets.

RLP Reader

The RLP Reader connects to and reads from the Loggregator Reverse Log Proxy. It can be ran with a delay, counter name filter, gauge name filter, preferredTags, deterministicName and/or shardID.

RLP Type Reader

The RLP Reader connects to and reads from the Loggregator Reverse Log Proxy. It can be ran with to only receive one or more different types of Envelopes.

Slow Consumer

The Slow Consumer is a firehose nozzle that will induce the TrafficController to cut off the nozzle.

Smoke Tests

Smoke Tests for CF Syslog Drain release which measures reliability at different rates.

Syslog Drain

The Syslog Drain is an example TCP server that accepts syslog messages (RFC-5424) via TCP. This is a useful tool for debugging and monitoring cf-syslog-drain-release. The Syslog drain can be configured to POST a counter.

Syslog Forwarder

Reads logs from the Loggregator V2 API via the RLP (Reverse Log Proxy) Gateway and writes logs for a configured source ID to a syslog endpoint. The syslog drains can be configured to use TCP, TCP w/ TLS or HTTPS.

Syslog to Datadog

The Syslog to Datadog is an example HTTPS server that accepts syslog messages (RFC-5424) with metrics in the structured data. The metrics will be sent to datadog.

The Syslog to Datadog application can be configured with DATADOG_API_KEY and PORT environment variables.