Skip to content

Commit 4405061

Browse files
committed
Add docs, specs, linter, elvis, and CI
1 parent b1ae3bc commit 4405061

31 files changed

+1176
-1493
lines changed

.dir-locals.el

Lines changed: 0 additions & 9 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- "*"
10+
workflow_dispatch: {}
11+
12+
jobs:
13+
test:
14+
name: OTP ${{matrix.otp}}
15+
runs-on: 'ubuntu-24.04'
16+
strategy:
17+
matrix:
18+
otp: ['27', '26', '25']
19+
rebar3: ['3.24.0']
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: erlef/setup-beam@v1
23+
with:
24+
otp-version: ${{matrix.otp}}
25+
rebar3-version: ${{matrix.rebar3}}
26+
- run: rebar3 compile
27+
- run: rebar3 lint
28+
- run: rebar3 fmt --check
29+
if: ${{ matrix.otp == '27' }}
30+
- run: rebar3 dialyzer
31+
if: ${{ matrix.otp == '27' }}
32+
- run: rebar3 ex_doc
33+
- run: rebar3 xref
34+
- run: rebar3 eunit
35+
- run: rebar3 ct
36+
- run: rebar3 do cover, covertool generate
37+
- name: Upload code coverage
38+
uses: codecov/codecov-action@v5
39+
with:
40+
files: _build/test/covertool/*.covertool.xml
41+
token: ${{ secrets.CODECOV_TOKEN }}
42+
fail_ci_if_error: true
43+
verbose: true

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ erl_crash.dump
1818
logs
1919
_build
2020
deps
21-
rebar.lock
2221
*.ez
22+
doc/

.travis.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
2-
31
# Prometheus.io inets httpd exporter #
42

5-
Copyright (c) 2017 Ilya Khaprov <<[email protected]>>.
6-
7-
__Version:__ 2.1.11
8-
93
[![Hex.pm](https://img.shields.io/hexpm/v/prometheus_httpd.svg?maxAge=2592000?style=plastic)](https://hex.pm/packages/prometheus_httpd)
104
[![Hex.pm](https://img.shields.io/hexpm/dt/prometheus_httpd.svg?maxAge=2592000)](https://hex.pm/packages/prometheus_httpd)
11-
[![Build Status](https://travis-ci.org/deadtrickster/prometheus_httpd.svg?branch=version-3)](https://travis-ci.org/deadtrickster/prometheus_httpd)
12-
[![Coverage Status](https://coveralls.io/repos/github/deadtrickster/prometheus_httpd/badge.svg?branch=master)](https://coveralls.io/github/deadtrickster/prometheus_httpd?branch=master)
5+
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/prometheus_httpd/)
6+
[![GitHub Actions](https://github.com/prometheus-erl/prometheus-httpd/actions/workflows/ci.yml/badge.svg)](https://github.com/prometheus-erl/prometheus-httpd/actions/workflows/ci.yml)
7+
[![Codecov](https://codecov.io/github/prometheus-erl/prometheus-httpd/graph/badge.svg?token=G9HB5UKNIY)](https://codecov.io/github/prometheus-erl/prometheus-httpd)
138

14-
Provides [httpd middleware](http://erlang.org/doc/man/httpd.html) "mod-module" (`prometheus_httpd`) for exposing [Prometheus.io](https://github.com/deadtrickster/prometheus.erl) metrics in various formats.
9+
Provides [httpd middleware](http://erlang.org/doc/man/httpd.html) "mod-module" (`prometheus_httpd`) for exposing [Prometheus.io](https://github.com/prometheus-erl/prometheus.erl) metrics in various formats.
1510

1611
Also can start its own httpd instance with just `prometheus_httpd` enabled.
1712

@@ -21,43 +16,29 @@ Also can start its own httpd instance with just `prometheus_httpd` enabled.
2116
prometheus_httpd:start()
2217
```
2318

24-
More in `prometheus_httpd` module [documentation](/deadtrickster/prometheus_httpd/blob/master/doc/prometheus_httpd.md)
19+
More in the `prometheus_httpd` module [documentation](https://hexdocs.pm/prometheus_httpd/prometheus_httpd.md)
2520

26-
![BEAM Dashboard](https://raw.githubusercontent.com/deadtrickster/beam-dashboards/master/BEAM.png)
21+
![BEAM Dashboard](https://raw.githubusercontent.com/prometheus-erl/beam-dashboards/master/BEAM.png)
2722

2823
- IRC: #erlang on Freenode;
2924
- [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).
3025

3126
## Integrations
3227
- [Ecto Instrumenter](https://hex.pm/packages/prometheus_ecto)
33-
- [Erlang client](https://github.com/deadtrickster/prometheus.erl)
34-
- [Elixir client](https://github.com/deadtrickster/prometheus.ex)
28+
- [Erlang client](https://github.com/prometheus-erl/prometheus.erl)
29+
- [Elixir client](https://github.com/prometheus-erl/prometheus.ex)
3530
- [Elixir plugs Instrumenters and Exporter](https://hex.pm/packages/prometheus_plugs)
3631
- [Extatus - App to report metrics to Prometheus from Elixir GenServers](https://github.com/gmtprime/extatus)
3732
- [Fuse plugin](https://github.com/jlouis/fuse#fuse_stats_prometheus)
3833
- [OS process info Collector](https://hex.pm/packages/prometheus_process_collector) (linux-only)
3934
- [Phoenix Instrumenter](https://hex.pm/packages/prometheus_phoenix)
40-
- [RabbitMQ Exporter](https://github.com/deadtrickster/prometheus_rabbitmq_exporter).
35+
- [RabbitMQ Exporter](https://github.com/prometheus-erl/prometheus_rabbitmq_exporter).
4136

4237
## Dashboards
4338

44-
- [Beam Dashboards](https://github.com/deadtrickster/beam-dashboards).
39+
- [Beam Dashboards](https://github.com/prometheus-erl/beam-dashboards).
4540

4641
## Blogs
4742

4843
- [Monitoring Elixir apps in 2016: Prometheus and Grafana](https://aldusleaf.org/monitoring-elixir-apps-in-2016-prometheus-and-grafana/)
4944
- [A Simple Erlang Application, with Prometheus](http://markbucciarelli.com/2016-11-23_a_simple_erlang_application_with_prometheus.html).
50-
51-
## License
52-
53-
MIT
54-
55-
56-
## Modules ##
57-
58-
59-
<table width="100%" border="0" summary="list of modules">
60-
<tr><td><a href="https://github.com/deadtrickster/prometheus_httpd/blob/master/doc/prometheus_http_impl.md" class="module">prometheus_http_impl</a></td></tr>
61-
<tr><td><a href="https://github.com/deadtrickster/prometheus_httpd/blob/master/doc/prometheus_httpd.md" class="module">prometheus_httpd</a></td></tr>
62-
<tr><td><a href="https://github.com/deadtrickster/prometheus_httpd/blob/master/doc/prometheus_httpd_ct.md" class="module">prometheus_httpd_ct</a></td></tr></table>
63-

bin/checks.sh

Lines changed: 0 additions & 3 deletions
This file was deleted.

bin/increment-version

Lines changed: 0 additions & 89 deletions
This file was deleted.

doc/README.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

doc/edoc-info

Lines changed: 0 additions & 3 deletions
This file was deleted.

doc/erlang.png

-2.06 KB
Binary file not shown.

0 commit comments

Comments
 (0)