API Reference PromEx v0.1.0-alpha

Modules

PromEx is a plugin based library which can be used to capture telemetry events and report them out for consumption by Prometheus. The main purpose of this particular library is to provide the behaviour that all PromEx plugins leverage so that a consistent interface can be achieved and so that leveraging multiple plugins is effortless from the user's point of view.

This module provides functions to generate histogram bucket ranges. The lists of buckets that can be generated are either linear or exponential.

This is a convenience module used for debugging and introspecting telemetry events. Primarily used to ease for development or PromEx itself.

This GenServer is responsible to keeping track of all the manual metrics from your configured plugins. It will fetch metrics initially when starting (either immediately or after a configured delay). At that point if you would like to refresh your metrics data points call the refresh_metrics/0 function.

This struct defines the fields necessary to export a group of standard metrics from a plugin.

This struct defines the fields necessary to export a group of manually collected metric sources from a plugin.

This struct defines the fields necessary to export a group of pollable metric sources from a plugin.

Use this plug in your Endpoint file to expose your metrics. The following options are supported by this plug

This plugin captures metrics regarding your application, and its dependencies. Specifically, it captures the versions of your application and the application dependencies and also how many modules each depepndency is bringing into the project.

Telemetry metrics for the BEAM.

Prometheus Reporter for Telemetry.Metrics definitions.

Mix Tasks

This will generate a PromEx config

This will generate a version diff of what is in PromEx and what's in Grafana

This will publish dashboards to grafana