README
¶
Loggregator Tools
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.
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 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.
Datadog Accumulator
The Datadog Accumulator scrapes Gauge values for a given source-id and send the results to Datadog.
Log Spinner
Log Spinner is a sample CF application that is written in go. It is compatible with the go-buildpack.
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.
Request Spinner
Request Spinner reads from Log Cache for load testing purposes. The request can be configured to hit specific source IDs, at a given cycle and delay.
Log Cache Siege
Log Cache Siege is configured with the address of a request-spinner to instruct request-spinner to hit every available source ID.
Log Cache Emitter
Log Cache Emitter is meant to be bosh deployed and will emit 10,000 logs to log cache for each source id given. request takes the form of GET to http://:/emit?sourceIDs=source1&sourceIDs=source2
Slow Consumer
The Slow Consumer is a firehose nozzle that will induce the TrafficController to cut off the nozzle.
Post Printer
The post printer is a CF application that prints every request to stderr.
Datadog Forwarder
The Datadog forwarder reads from Log Cache and forwards metrics to Datadog.
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.
Syslog Nozzle
This is a nozzle that converts envelopes into syslog messages. This is meant to be deployed in Kubernetes. The dockerfile for packaging this app is located here. The kubernetes deployment manifest and instructions for configuring it can be found here.
Directories
¶
| Path | Synopsis |
|---|---|
|
constlogger
module
|
|
|
dummymetron: a program that accepts envelopes via UDP (v1) and gRPC (v2).
|
dummymetron: a program that accepts envelopes via UDP (v1) and gRPC (v2). |
|
echo
module
|
|
|
emitter: a tool to emit envelopes to the agent via v2 gRPC.
|
emitter: a tool to emit envelopes to the agent via v2 gRPC. |
|
envelopeemitter: a tool to emit envelopes via v2 gRPC
|
envelopeemitter: a tool to emit envelopes via v2 gRPC |
|
experimental
|
|
|
latency-log-cache
module
|
|
|
log-cache-forwarders
|
|
|
logemitter
module
|
|
|
lograter
module
|
|
|
metric-server
module
|
|
|
Messages that have the origin "fast" will be aggregated and a rate will print every second.
|
Messages that have the origin "fast" will be aggregated and a rate will print every second. |
|
postcounter
module
|
|
|
reliability
module
|
|
|
rlpreader: a tool that reads messages from RLP.
|
rlpreader: a tool that reads messages from RLP. |
|
rlpreader: a tool that reads messages from RLP.
|
rlpreader: a tool that reads messages from RLP. |
|
rlpwriter: a tool that writes messages into RLP.
|
rlpwriter: a tool that writes messages into RLP. |
|
syslog-forwarder
module
|
|
|
syslogspinner
module
|
|
|
tcpprinter
module
|
|
|
udpwriter: a tool that writes messages into a metron via UDP.
|
udpwriter: a tool that writes messages into a metron via UDP. |