Categorygithub.com/honeycombio/beeline-go
modulepackage
1.18.0
Repository: https://github.com/honeycombio/beeline-go.git
Documentation: pkg.go.dev

# README

Honeycomb Beeline for Go

OSS Lifecycle CircleCI GoDoc

⚠️Note: Beelines are Honeycomb's legacy instrumentation libraries. We embrace OpenTelemetry as the effective way to instrument applications. For any new observability efforts, we recommend instrumenting with OpenTelemetry.

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

Golang 1.19+

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
Package propagation includes types and functions for marshalling and unmarshalling trace context headers between various supported formats and an internal representation.
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.
No description provided by the author
StartSpan lets you start a new span as a child of an already instrumented handler.

# Structs

Config is the place where you configure your Honeycomb write key and dataset name.