Skip to content

Commit f4ae8cb

Browse files
committed
Added README
1 parent 34f3586 commit f4ae8cb

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# <img src="https://static-00.iconduck.com/assets.00/prometheus-icon-511x512-1vmxbcxr.png" width="50"/> Auto Prometheus Exporter
2+
[![Release](https://github.com/MGSousa/prom-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/MGSousa/prom-exporter/actions/workflows/release.yml)
3+
4+
Prometheus exporter that fetches and auto-resolves JSON data from selected services by converting metrics/stats in Prometheus format, being ready to be scrapped.
5+
6+
Compatible with Elastic Beats plugins (Filebeat, Auditbeat, Packetbeat, Metricbeat, etc.) and any other tool that has any HTTP endpoint with output in JSON.
7+
8+
## Install
9+
### Linux / Darwin
10+
- specify version
11+
```sh
12+
VERSION=1.0.0
13+
wget -nv https://github.com/MGSousa/prom-exporter/releases/download/v$VERSION/prom-exporter_${VERSION}_$(uname | awk '{print tolower($0)}')_amd64 -O prom-exporter && chmod +x prom-exporter
14+
```
15+
16+
- or fetch the latest release
17+
```sh
18+
curl -fsL "https://api.github.com/repos/MGSousa/prom-exporter/releases/latest" |\
19+
jq -r ".assets[] | select(.name|contains(\"$(uname | awk '{print tolower($0)}')\")) | .url" |\
20+
wget --header="Accept: application/octet-stream" -O prom-exporter -nv -i - && chmod +x prom-exporter
21+
```
22+
### Windows
23+
```sh
24+
curl -o prom-exporter.exe https://github.com/MGSousa/prom-exporter/releases/download/v1.0.0/prom-exporter_1.0.0_windows_amd64.exe
25+
```
26+
27+
## Usage
28+
```sh
29+
./prom-exporter -service-uri "REMOTE_HOST:PORT"-service-name "SERVICE_NAME" -service-metrics-path "REMOTE_PATH"

0 commit comments

Comments
 (0)