Telegraf v0.1.1

Telegraf (Telegraf v0.1.1) View Source

Telegraf client.

Hex.pm Version CI codecov

Checkout the documentation for more information.

Installation

The package can be installed by adding telegraf to your list of dependencies in mix.exs:

def deps do
  [
    {:telegraf, "~> 0.1.1"}
  ]
end

Usage

  1. Add Telegraf to your supervision tree:
{Telegraf, name: MyTelegraf}
  1. Send the metric:
metric = %Telegraf.Metric{
  name: "weather",
  tag_set: %{location: "us-midwest"},
  field_set: %{temperature: 82},
  timestamp: System.os_time()
}

Telegraf.send(MyTelegraf, metric)

Changelog

See the changelog.

Link to this section Summary

Types

name()

Name of the telegraf instance.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

send(name, metric_or_metrics, opts \\ [])

Sends a metric to the telegraf daemon

start_link(opts)

Starts a Telegraf supervisor.

Link to this section Types

Link to this type

name()

View Source

Specs

name() :: atom()

Name of the telegraf instance.

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

send(name, metric_or_metrics, opts \\ [])

View Source

Specs

send(name(), Metric.t() | [Metric.t()], Keyword.t()) :: :ok | {:error, term()}

Sends a metric to the telegraf daemon

metric = %Telegraf.Metric{
  name: "weather",
  tag_set: %{location: "us-midwest"},
  field_set: %{temperature: 82},
  timestamp: System.os_time()
}

Telegraf.send(MyTelegraf, metric)
Link to this function

start_link(opts)

View Source

Starts a Telegraf supervisor.

Supported options