@spec csv(binary(), export_metric_type(), map(), [csv_export_opt()]) ::
  :ok | {:ok, binary()} | {:error, Mobius.Exports.UnsupportedMetricError.t()}

Generate a CSV for the metric

Please see Mobius.Exporters.CSV for more information.

# Return CSV as string
{:ok, csv_string} = Mobius.Exports.csv("vm.memory.total", :last_value, %{})

# Write to console
Mobius.Exports.csv("vm.memory.total", :last_value, %{}, iodevice: :stdio)

# Write to a file
file = File.open("mycsv.csv", [:write])
:ok = Mobius.Exports.csv("vm.memory.total", :last_value, %{}, iodevice: file)

@spec mbf([mfb_export_opt()]) ::
  binary() | {:ok, Path.t()} | {:error, Mobius.FileError.t()}

Export all metrics in the Mobius Binary Format (MBF)

This is mostly useful when you want to share metric data with different networked services.

The binary format is <<version, metric_data::binary>>

The first byte is the version number of the following metric data. Currently, the version number is 1.

The metric data binary is the type of [Mobius.metric()] encoded in Binary ERlang Term format (BERT) and compressed (using Zlib compression).

Optionally, to_mbf/1 can write the binary to a file using the :out_dir option.

Mobius.Exports.to_mbf(out_dir: "/my/dir")

The generated file is returned as {:ok, filename}. The format of the file name is YYYYMMDDHHMMSS-metrics.mbf.

See Mobius.Exports.parse_mbf/1 to parse a binary in MBF.

@spec metrics(
  Mobius.metric_name(),
  Mobius.metric_type(),
  map(),
  [export_opt()] | keyword()
) :: [
  Mobius.metric()
]

Retrieve the raw metric data from the history store for a given metric.

Output will be a list of metric values, which will be in the format, eg: %{type: :last_value, value: 12, tags: %{interface: "eth0"}, timestamp: 1645107424}

If there are tags for the metric you can pass those in the third argument:

Mobius.Exports.metrics("vm.memory.total", :last_value, %{some: :tag})

By default the filter will display the last 3 minutes of metric history.

However, you can pass the :from and :to options to look at a specific range of time.

Mobius.Exports.metrics("vm.memory.total", :last_value, %{}, from: 1630619212, to: 1630619219)

You can also filter data over the last x amount of time. Where x is an integer. When there is no time_unit() provided the unit is assumed to be :second.

Retrieving data over the last 30 seconds:

Mobius.Exports.metrics("vm.memory.total", :last_value, %{}, last: 30)

Retrieving data over the last 2 hours:

Mobius.Exports.metrics("vm.memory.total", :last_value, %{}, last: {2, :hour})

Retrieving summary data can be performed by specifying the type: :summary - however, this returns value data in the form of a map, which cannot be plotted or csv exported. To reduce the output to a single metric value, use the form: {:summary, :summary_metric}

Mobius.Exports.metrics("vm.memory.total", {:summary, :average}, %{}, last: {2, :hour})

@spec parse_mbf(binary()) ::
  {:ok, [Mobius.metric()]} | {:error, Mobius.Exports.MBFParseError.t()}

Parse the mobius binary format into a list of metrics

@spec plot(Mobius.metric_name(), export_metric_type(), map(), [export_opt()]) ::
  :ok | {:error, Mobius.Exports.UnsupportedMetricError.t()}

Plot the metric name to the screen

This takes the same arguments as for filter_metrics, eg:

If there are tags for the metric you can pass those in the second argument:

Mobius.Exports.plot("vm.memory.total", :last_value, %{some: :tag})

By default the plot will display the last 3 minutes of metric history.

However, you can pass the :from and :to options to look at a specific range of time.

Mobius.Exports.plot("vm.memory.total", :last_value, %{}, from: 1630619212, to: 1630619219)

You can also plot data over the last x amount of time. Where x is an integer. When there is no time_unit() provided the unit is assumed to be :second.

Plotting data over the last 30 seconds:

Mobius.Export.plot("vm.memory.total", :last_value, %{}, last: 30)

Plotting data over the last 2 hours:

Mobius.Export.plot("vm.memory.total", :last_value, %{}, last: {2, :hour})

Retrieving summary data can be performed by specifying type of the form: {:summary, :summary_metric}

Mobius.Exports.metrics("vm.memory.total", {:summary, :average}, %{}, last: {2, :hour})

@spec series(String.t(), export_metric_type(), map(), [export_opt()]) :: [integer()]

Generates a series that contains the value of the metric