Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/deadtrickster/prometheus.ex

Prometheus.io Elixir client
https://github.com/deadtrickster/prometheus.ex

elixir instrumentation metrics monitoring prometheus

Last synced: about 2 months ago
JSON representation

Prometheus.io Elixir client

Host: GitHub
URL: https://github.com/deadtrickster/prometheus.ex
Owner: deadtrickster
Created: 2016-05-16T22:12:44.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-01-04T09:31:12.000Z (5 months ago)
Last Synced: 2024-04-26T22:43:25.530Z (about 2 months ago)
Topics: elixir, instrumentation, metrics, monitoring, prometheus
Language: Elixir
Homepage:
Size: 201 KB
Stars: 402
Watchers: 9
Forks: 69
Open Issues: 17
Metadata Files:
- Readme: README.md

Lists

awesome-elixir - prometheus.ex - Elixir-friendly [Prometheus.io](https://prometheus.io) monitoring system and time series database client. (Instrumenting / Monitoring)
freaking_awesome_elixir - Elixir - Elixir-friendly [Prometheus.io](https://prometheus.io) monitoring system and time series database client. (Instrumenting / Monitoring)
awesome-elixir - prometheus.ex - Elixir-friendly [Prometheus.io](https://prometheus.io) monitoring system and time series database client. (Instrumenting / Monitoring)
fucking-awesome-elixir - prometheus.ex - Elixir-friendly [Prometheus.io](https://prometheus.io) monitoring system and time series database client. (Instrumenting / Monitoring)

README

        # Prometheus.ex

[![Build Status](https://github.com/deadtrickster/prometheus.ex/workflows/build/badge.svg)](https://github.com/deadtrickster/prometheus.ex/actions?query=branch%3Amaster)

[![Hex.pm](https://img.shields.io/hexpm/dt/prometheus_ex.svg?maxAge=2592000)](https://hex.pm/packages/prometheus_ex)

[![Coverage Status](https://coveralls.io/repos/github/deadtrickster/prometheus.ex/badge.svg?branch=master)](https://coveralls.io/github/deadtrickster/prometheus.ex?branch=master)

[![Hex.pm](https://img.shields.io/hexpm/v/prometheus_ex.svg?maxAge=2592000)](https://hex.pm/packages/prometheus_ex)

[![Documentation](https://img.shields.io/badge/documentation-on%20hexdocs-green.svg)](https://hexdocs.pm/prometheus_ex/)

Elixir [Prometheus.io](https://prometheus.io) client based on [Prometheus.erl](https://github.com/deadtrickster/prometheus.erl).

Starting from v3.0.0 works with Elixir >=1.6 and Erlang >=20. For older versions, please use older tags.

![@skosch dashboard](https://aldusleaf.org/assets/images/2016/09/grafana.jpg)

Dashboard from [Monitoring Elixir apps in 2016: Prometheus and Grafana](https://aldusleaf.org/monitoring-elixir-apps-in-2016-prometheus-and-grafana) by [**@skosch**](https://github.com/skosch).

 - IRC: #elixir-lang on Freenode;

 - [Slack](https://elixir-slackin.herokuapp.com/): #prometheus channel - [Browser](https://elixir-lang.slack.com/messages/prometheus) or App(slack://elixir-lang.slack.com/messages/prometheus).

## Example

```elixir

defmodule ExampleInstrumenter do

  use Prometheus.Metric

  def setup do    

    Histogram.new([name: :http_request_duration_milliseconds,

                   labels: [:method],

                   buckets: [100, 300, 500, 750, 1000],

                   help: "Http Request execution time"])

  end

  def instrument(%{time: time, method: method}) do

    Histogram.observe([name: :http_request_duration_milliseconds, labels: [method]], time)

  end

end

```

or

```elixir

defmodule ExampleInstrumenter do

  use Prometheus.Metric

  @histogram [name: :http_request_duration_milliseconds,

              labels: [:method],

              buckets: [100, 300, 500, 750, 1000],

              help: "Http Request execution time"]

  def instrument(%{time: time, method: method}) do

    Histogram.observe([name: :http_request_duration_milliseconds, labels: [method]], time)

  end

end

```

Here histogram will be declared in auto-generated `@on_load` callback, i.e.

you don't have to call setup manually.

Please read how to [measure durations correctly with prometheus.ex](https://hexdocs.pm/prometheus_ex/time.html#content).

## Integrations / Collectors / Instrumenters

 - [Ecto collector](https://github.com/deadtrickster/prometheus-ecto)

 - [Elli middleware](https://github.com/elli-lib/elli_prometheus)

 - [Extatus - App to report metrics to Prometheus from Elixir GenServers](https://github.com/gmtprime/extatus)

 - [Plugs Instrumenter/Exporter](https://github.com/deadtrickster/prometheus-plugs)

 - [Fuse plugin](https://github.com/jlouis/fuse#fuse_stats_prometheus)

 - [OS process info Collector](https://hex.pm/packages/prometheus_process_collector) (Linux-only)

 - [Phoenix instrumenter](https://github.com/deadtrickster/prometheus-phoenix)

 - [RabbitMQ Exporter](https://github.com/deadtrickster/prometheus_rabbitmq_exporter)

## Dashboards

- [Beam Dashboards](https://github.com/deadtrickster/beam-dashboards).

## Installation

[Available in Hex](https://hex.pm/packages/prometheus_ex), the package can be installed as:

1. Add `prometheus_ex` to your list of dependencies in `mix.exs`:

    ```elixir

    def deps do

      [{:prometheus_ex, "~> 3.1"}]

    end

    ```

2. Ensure `prometheus_ex` is started before your application:

    ```elixir

    def application do

      [applications: [:prometheus_ex]]

    end

    ```