k8s v0.5.2 K8s.Sys.Event

K8s.Sys.Event is a thin wrapper around :telemetry.

All events will be prefixed with k8s.

The following events are emitted:

  • [:k8s, :cluster, :registered]
  • [:k8s, :http, :request, :failed]
  • [:k8s, :http, :request, :succeeded]

To access this list programmatically use events/0.

If set, default metadata will be applied to all events. See: metadata/0

Link to this section Summary

Functions

When a cluster is successfully registered

Returns a list of all events emitted by this module

K8s.Client.HTTPProvider request failed

K8s.Client.HTTPProvider request succeeded

Default metadata added to all events.

Merges metadata with defaults

The instrumenter name

Link to this section Functions

Link to this function

cluster_registered(measurements, metadata \\ %{})

cluster_registered(map(), map()) :: :ok

When a cluster is successfully registered

Link to this function

events()

events() :: [[atom()]]

Returns a list of all events emitted by this module:

  • [:k8s, :cluster, :registered]
  • [:k8s, :http, :request, :failed]
  • [:k8s, :http, :request, :succeeded]

Great for use with :telemetry.attach_many/4

Link to this function

http_request_failed(measurements, metadata \\ %{})

http_request_failed(map(), map()) :: :ok

K8s.Client.HTTPProvider request failed

Link to this function

http_request_succeeded(measurements, metadata \\ %{})

http_request_succeeded(map(), map()) :: :ok

K8s.Client.HTTPProvider request succeeded

Link to this function

metadata()

metadata() :: map()

Default metadata added to all events.

Defaults: %{}

Link to this function

metadata(alt)

metadata(map()) :: map()

Merges metadata with defaults

Link to this function

name()

name() :: atom()

The instrumenter name