opencensus_honeycomb v0.3.0 Opencensus.Honeycomb.Config

Configuration.

Out of the box, we supply suitable defaults for everything except write_key. To override the defaults, set the application environment in config/config.exs using keys from t/0:

config :opencensus,
  reporters: [{Opencensus.Honeycomb.Reporter, []}],
  send_interval_ms: 1000

config :opencensus_honeycomb,
  dataset: "opencensus",
  service_name: "your_app",
  samplerate_key: "samplerate",
  write_key: System.get_env("HONEYCOMB_WRITEKEY")

If you're using Mix, you probably won't need to use effective/0, get/0, and put/1.

Link to this section Summary

Types

decorator()

The module and keyword arguments for your Opencensus.Honeycomb.Decorator implementation.

t()

Our configuration struct.

Functions

effective()

Get the effective configuration, using default values where necessary.

get()

Get the application configuration without using default values.

into(fields)

Inserts into the application configuration.

put(config)

Put to the application configuration.

Link to this section Types

decorator()

decorator() :: {module(), keyword()}

The module and keyword arguments for your Opencensus.Honeycomb.Decorator implementation.

t()

t() :: %Opencensus.Honeycomb.Config{
  api_endpoint: String.t() | nil,
  batch_size: integer() | nil,
  dataset: String.t() | nil,
  decorator: decorator() | nil,
  samplerate_key: String.t() | nil,
  service_name: String.t() | nil,
  write_key: String.t() | nil
}

Our configuration struct.

api_endpoint: the API endpoint
batch_size: the batch size
dataset: the dataset
decorator: the decorator module and arguments (nil disables decoration)
service_name: the service name
samplerate_key: the sample rate key (nil disables setting the sample rate)
write_key: the write key (nil disables sending spans)

Default values:

api_endpoint: "https://api.honeycomb.io"
batch_size: 100
dataset: "opencensus"
decorator: nil
samplerate_key: nil
service_name: "-"
write_key: nil

Link to this section Functions