OpenTelemetry.Vendor.Honeycomb

Vendor integration for Honeycomb.

This lets you link to traces. You don't need this to send data to Honeycomb, for which hs-opentelemetry-exporter-otlp is suitable.

Types

newtype HoneycombTeam

Honeycomb team name; generally appears in the URL after ui.honeycomb.io/.

Constructors

HoneycombTeam

Fields

• unHoneycombTeam :: Text

Instances

IsString HoneycombTeam

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

fromString :: String -> HoneycombTeam

Show HoneycombTeam

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

showsPrec :: Int -> HoneycombTeam -> ShowS

show :: HoneycombTeam -> String

showList :: [HoneycombTeam] -> ShowS

Eq HoneycombTeam

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

(==) :: HoneycombTeam -> HoneycombTeam -> Bool

(/=) :: HoneycombTeam -> HoneycombTeam -> Bool

newtype EnvironmentName

Environment name in the Environments & Services data model (referred to as "Current" in this package).

See https://docs.honeycomb.io/honeycomb-classic/ for more details.

Constructors

EnvironmentName

Fields

• unEnvironmentName :: Text

Instances

IsString EnvironmentName

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

fromString :: String -> EnvironmentName

Show EnvironmentName

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

showsPrec :: Int -> EnvironmentName -> ShowS

show :: EnvironmentName -> String

showList :: [EnvironmentName] -> ShowS

Eq EnvironmentName

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

(==) :: EnvironmentName -> EnvironmentName -> Bool

(/=) :: EnvironmentName -> EnvironmentName -> Bool

Getting the Honeycomb target dataset/team name

getOrInitializeHoneycombTargetInContext

Arguments

:: MonadIO m

=> NominalDiffTime

Timeout for the operation before assuming Honeycomb is inaccessible

-> m (Maybe HoneycombTarget)

Gets or initializes the Honeycomb target in the thread-local Context.

This should be called inside the root span at application startup in order to ensure that this context is the parent of all child contexts in which you might want to get the target (for instance to generate Honeycomb links).

getHoneycombTargetInContext :: MonadIO m => m (Maybe HoneycombTarget)

Simple function to get the Honeycomb target out of the global context.

At application startup, run getOrInitializeHoneycombTargetInContext before calling this, or else you will get Nothing.

This is the right function for most use cases.

Detailed API

getConfigPartsFromEnv :: MonadIO m => TracerProvider -> m (Maybe (Text, DatasetName))

Gets the Honeycomb configuration from the environment.

This does not do any HTTP.

FIXME(jadel): This should ideally fetch this from the tracer provider, but it's nonobvious how to architect being able to do that (requires changes in hs-opentelemetry-api). For now let's take a Tracer such that we can fix it later, then do it the obvious way.

getHoneycombData :: MonadIO m => Config -> m (HoneycombTeam, Maybe EnvironmentName)

Gets the team name and environment name for the OTLP exporter using the API key from the environment.

This calls Honeycomb.

N.B. Use config to construct a config from getConfigPartsFromEnv.

N.B. The EnvironmentName will be Nothing if the API key is for a Honeycomb Classic instance.

resolveHoneycombTarget :: MonadIO m => TracerProvider -> Config -> m (Maybe HoneycombTarget)

Takes a Config and pokes around both Honeycomb HTTP API and the trace environment to figure out where events will land in Honeycomb.

data DatasetInfo

Either a current-Honeycomb environment+dataset pair, or a Honeycomb Classic dataset

Constructors

Current EnvironmentName DatasetName

Classic DatasetName

Instances

Show DatasetInfo

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

showsPrec :: Int -> DatasetInfo -> ShowS

show :: DatasetInfo -> String

showList :: [DatasetInfo] -> ShowS

Eq DatasetInfo

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

(==) :: DatasetInfo -> DatasetInfo -> Bool

(/=) :: DatasetInfo -> DatasetInfo -> Bool

data HoneycombTarget

A fully qualified Honeycomb dataset, possibly with environment.

Constructors

HoneycombTarget

Fields

• targetTeam :: HoneycombTeam
• targetDataset :: DatasetInfo

Instances

Show HoneycombTarget

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

showsPrec :: Int -> HoneycombTarget -> ShowS

show :: HoneycombTarget -> String

showList :: [HoneycombTarget] -> ShowS

Eq HoneycombTarget

Defined in OpenTelemetry.Vendor.Honeycomb

Methods

(==) :: HoneycombTarget -> HoneycombTarget -> Bool

(/=) :: HoneycombTarget -> HoneycombTarget -> Bool

Making trace links

makeDirectTraceLink :: HoneycombTarget -> UTCTime -> TraceId -> ByteString

Formats a direct link to a trace.

See https://docs.honeycomb.io/api/direct-trace-links/ for more details.

The URLs generated will look like the following:

Honeycomb Current:

https://ui.honeycomb.io/<team>/environments/<environment>/datasets/<dataset>/trace
  ?trace_id=<traceId>
  &trace_start_ts=<ts>
  &trace_end_ts=<ts>

Honeycomb Classic:

https://ui.honeycomb.io/<team>/datasets/<dataset>/trace
  ?trace_id=<traceId>
  &trace_start_ts=<ts>
  &trace_end_ts=<ts>

getHoneycombLink :: MonadIO m => m (Maybe ByteString)

Gets a trace link for the current trace.

Needs to have the thread-local target initialized; see getOrInitializeHoneycombTargetInContext.

getHoneycombLink' :: MonadIO m => HoneycombTarget -> m (Maybe ByteString)

Gets a trace link for the current trace with an explicitly provided target.

Performing manual Honeycomb requests

module Honeycomb.API.Auth

module Honeycomb.Config