https://github.com/deadtrickster/prometheus-phoenix

Prometheus.io Phoenix instrumenter
https://github.com/deadtrickster/prometheus-phoenix

collector elixir instrumentation monitoring phoenix prometheus

Last synced: 19 days ago
JSON representation

Prometheus.io Phoenix instrumenter

• Host: GitHub
• URL: https://github.com/deadtrickster/prometheus-phoenix
• Owner: deadtrickster
• Created: 2016-08-19T09:35:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-02-25T03:53:57.000Z (almost 4 years ago)
• Last Synced: 2024-10-29T20:35:34.945Z (about 1 month ago)
• Topics: collector, elixir, instrumentation, monitoring, phoenix, prometheus
• Language: Elixir
• Size: 52.7 KB
• Stars: 71
• Watchers: 9
• Forks: 20
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Phoenix instrumenter for prometheus.ex. (Instrumenting / Monitoring)
• fucking-awesome-elixir - prometheus-phoenix - Phoenix instrumenter for prometheus.ex. (Instrumenting / Monitoring)
• awesome-elixir - prometheus-phoenix - Phoenix instrumenter for prometheus.ex. (Instrumenting / Monitoring)

README

        
# Prometheus.io Phoenix Instrumenter

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

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

[![Build Status](https://travis-ci.org/deadtrickster/prometheus-phoenix.svg?branch=master)](https://travis-ci.org/deadtrickster/prometheus-phoenix)

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

Phoenix integration for [Prometheus.ex](https://github.com/deadtrickster/prometheus.ex).

 - 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).

## Metrics

  Metrics implemented for the following built-in events:

  - `phoenix_controller_call`

    - `phoenix_controller_call_duration_`;

  - `phoenix_controller_render`

    - `phoenix_controller_render_duration_`;

  - `phoenix_channel_join`

    - `phoenix_channel_join_duration_`;

  - `phoenix_channel_receive`

    - `phoenix_channel_receive_duration_`.

    

## Live endpoint

https://slackinex.herokuapp.com/metrics

## Configuration

This integration is configured via  `:prometheus` app env key. Please see `Prometheus.PhoenixInstrumenter` module documentation for more information.

## Integrations / Collectors / Instrumenters

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

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

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

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

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

 - [Process Info Collector](https://github.com/deadtrickster/prometheus_process_collector.erl)

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

## Installation

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

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

  

   ```elixir

   def deps do

     [{:prometheus_phoenix, "~> 1.3.0"}]

   end

   ```

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

   ```elixir

   def application do

     [applications: [:prometheus_phoenix]]

   end

   ```