opentelemetry_honeycomb v0.5.0-rc.1 OpenTelemetry.Honeycomb.Http behaviour View Source

HTTP back end.

The OpenTelemetry Honeycomb Exporter uses a Hackney-style HTTP client via a behaviour so you can adapt it to your preferred HTTP client. We supply 2-3 clients:

OpenTelemetry.Honeycomb.Http.HackneyBackend (only if :hackney is present)
OpenTelemetry.Honeycomb.Http.WriteKeyMissingBackend
OpenTelemetry.Honeycomb.Http.ConsoleBackend

Link to this section Summary

Types

body()

Request body

Configuration option for request!/5

HTTP headers

method()

HTTP method

Client response

status()

HTTP status code

url()

URL

Functions

default_config()

Return the default configuration for request!/5.

request(config, method, url, headers, body, opts)

Make an HTTP request using the configured back end and options.

Callbacks

request(method, url, headers, body, opts)

Make an HTTP request.

Link to this section Types

body()

body() :: iodata()

Request body

config_opt()

config_opt() :: {:http_module, module()} | {:http_options, Keyword.t()}

Configuration option for request!/5:

http_module: the HTTP back end module
http_options: options to pass to the HTTP back end

headers()

headers() :: [{String.t(), String.t()}]

HTTP headers

method()

method() :: :post

HTTP method

response()

response() ::
  {:ok, status(), headers(), body()}
  | {:ok, status(), headers()}
  | {:error, term()}

Client response

status()

status() :: integer()

HTTP status code

url()

url() :: String.t()

URL

Link to this section Functions

default_config()

Return the default configuration for request!/5.

request(config, method, url, headers, body, opts)

request(
  config :: [config_opt()],
  method :: method(),
  url :: url(),
  headers :: headers(),
  body :: body(),
  opts :: keyword()
) :: response()

Make an HTTP request using the configured back end and options.

Heavy on guards to limit the exporter's use of the API to the back end's documented subset of :hackney.request/5.

Link to this section Callbacks

request(method, url, headers, body, opts)

request(
  method :: method(),
  url :: url(),
  headers :: headers(),
  body :: body(),
  opts :: keyword()
) :: response()

Make an HTTP request.

See :hackney.request/5.