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
Dropsonde is a two-way protocol for emitting events and metrics in one direction. Messages are encoded in the Google Protocol Buffer binary wire format.
It is a goal of the system to reduce the need for low-level metric events (e.g. ValueMetric and CounterEvent messages). Though in the early stages, we include types such as HttpStartEvent, HttpStopEvent and HttpStartStopEvent to allow metric generation and aggregation at a higher level of abstraction, and to offload the work of aggregation to downstream receivers. Emitting applications should focus on delivering events, not processing them or computing statistics.
This protocol forms the backbone of the Doppler system of Cloud Foundry.
Please see the following for detailed descriptions of each type:
- Sonde-Go is a generated Go library for components that wish to emit messages to or consume messages from the Cloud Foundry metric system.
Install protobuf.
Note: Due to maps not being supported in protoc v2.X, the proto definitions in this repository require protoc v3.0.0 or higher.
On mac:
brew install protobuf
The Sonde-Go library can be used instead.
Or, from your working directory, where $DST_DIR is the desired destination:
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
protoc --go_out=. dropsonde-protocol/events/*.proto
mv github.com/cloudfoundry/sonde-go/events/*.pb.go $DST_DIR
rm -rf github.com
From your working directory, where $DST_DIR is the desired destination:
protoc --java_out=. dropsonde-protocol/events/*.proto
mv org/cloudfoundry/dropsonde/events/*.java $DST_DIR
rm -rf org
For C++ and Python, Google provides tutorials.
Please see this list for working with protocol buffers in other languages.
Each package's documentation is auto-generated with protoc-gen-doc. After installing the tool, run the following from your working directory:
protoc --doc_out=markdown,README.md:dropsonde-protocol/events dropsonde-protocol/events/*.proto
Dropsonde is intended to be a "fire and forget" protocol, in the sense that an emitter should send events to its receiver with no expectation of acknowledgement. There is no "handshake" step; the emitter simply begins emitting to a known address of an expected recipient.