Page MenuHomePhorge
Files F140865

No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/README.md b/README.md
index 87f0ebc..6a43ddc 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,51 @@
-# PrometheusEx
+# Prometheus.ex [![Build Status](https://travis-ci.org/deadtrickster/prometheus.ex.svg?branch=master)](https://travis-ci.org/deadtrickster/prometheus.ex) [![Hex.pm](https://img.shields.io/hexpm/v/prometheus_ex.svg?maxAge=2592000)](https://hex.pm/packages/prometheus_ex)
-**TODO: Add description**
+Elixir [Prometheus.io](https://prometheus.io) client based on [Prometheus.erl](https://github.com/deadtrickster/prometheus.erl).
+
+## 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
+```
+
+## Integrations / Collectors / Instrumenters
+ - [Ecto collector](https://github.com/deadtrickster/prometheus-ecto)
+ - [Elixir plugs](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
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
+[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, "~> 0.1.0"}]
+ [{:prometheus_ex, "~> 0.0.1"}]
end
```
2. Ensure `prometheus_ex` is started before your application:
```elixir
def application do
[applications: [:prometheus_ex]]
end
```

File Metadata

Mime Type
text/x-diff
Expires
Wed, Jan 22, 5:03 AM (1 d, 18 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
55791
Default Alt Text
(2 KB)

Event Timeline