# README
Honeycomb Beeline for Go
This package makes it easy to instrument your Go app to send useful events to Honeycomb, a service for debugging your software in production.
Dependencies
The beeline is written with an eye towards a fairly recent set of dependent packages. Some of the dependencies have changed their API interface over the past few years (eg goji, uuid, net/http) so you may need to upgrade to get to a place that works.
- go 1.9+ - the context package moved into the core library and is used extensively by the beeline to make events available to the call stack
- github.com/google/uuid v0.2+ - the signature for NewRandom started returning
UUID, error - github.com/goji/goji v2.0+ - they started using contexts in
net/httpinstead of their own
Contributions
Features, bug fixes and other changes to beeline-go are gladly accepted. Please
open issues or a pull request with your change. Remember to add your name to the
CONTRIBUTORS file!
All contributions will be released under the Apache License 2.0.
# Packages
Package client is used to store the state of the libhoney client that sends all beeline events, and provides wrappers of libhoney API functions that are safe to use even if the client is not initialized.
No description provided by the author
No description provided by the author
No description provided by the author
Package timer is a small convenience package for timing blocks of code.
Package trace gives access to direct control over the span and trace objects used by the beeline.
No description provided by the author
# Functions
AddField allows you to add a single field to an event anywhere downstream of an instrumented request.
AddFieldToTrace adds the field to both the currently active span and all other spans involved in this trace that occur within this process.
Close shuts down the beeline.
Flush sends any pending events to Honeycomb.
Init intializes the honeycomb instrumentation library.
StartSpan lets you start a new span as a child of an already instrumented handler.