README.md
# Prometheus.io Phoenix Instrumenter
[](https://hex.pm/packages/prometheus_phoenix)
[](https://hex.pm/packages/prometheus_phoenix)
[](https://travis-ci.org/deadtrickster/prometheus-phoenix)
[](https://hexdocs.pm/prometheus_phoenix/)
Phoenix integeration 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_<duration_unit>`;
- `phoenix_controller_render`
- `phoenix_controller_render_duration_<duration_unit>`;
- `phoenix_channel_join`
- `phoenix_channel_join_duration_<duration_unit>`;
- `phoenix_channel_receive`
- `phoenix_channel_receive_duration_<duration_unit>`.
## Live endpoint
https://slackinex.herokuapp.com/metrics
## Configuration
This integration is configured via <InstrumenterName> `: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
```