Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
MGSousa committed Dec 3, 2023
1 parent 34f3586 commit f4ae8cb
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# <img src="https://static-00.iconduck.com/assets.00/prometheus-icon-511x512-1vmxbcxr.png" width="50"/> Auto Prometheus Exporter
[![Release](https://github.com/MGSousa/prom-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/MGSousa/prom-exporter/actions/workflows/release.yml)

Prometheus exporter that fetches and auto-resolves JSON data from selected services by converting metrics/stats in Prometheus format, being ready to be scrapped.

Compatible with Elastic Beats plugins (Filebeat, Auditbeat, Packetbeat, Metricbeat, etc.) and any other tool that has any HTTP endpoint with output in JSON.

## Install
### Linux / Darwin
- specify version
```sh
VERSION=1.0.0
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
```

- or fetch the latest release
```sh
curl -fsL "https://api.github.com/repos/MGSousa/prom-exporter/releases/latest" |\
jq -r ".assets[] | select(.name|contains(\"$(uname | awk '{print tolower($0)}')\")) | .url" |\
wget --header="Accept: application/octet-stream" -O prom-exporter -nv -i - && chmod +x prom-exporter
```
### Windows
```sh
curl -o prom-exporter.exe https://github.com/MGSousa/prom-exporter/releases/download/v1.0.0/prom-exporter_1.0.0_windows_amd64.exe
```

## Usage
```sh
./prom-exporter -service-uri "REMOTE_HOST:PORT"-service-name "SERVICE_NAME" -service-metrics-path "REMOTE_PATH"

0 comments on commit f4ae8cb

Please sign in to comment.