Skip to content

Commit 4ac7def

Browse files
author
Igor Živković
committed
better doc
1 parent 1ce0ceb commit 4ac7def

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
1-
# Tinyproxy exporter
2-
Prometheus exporter for Tinyproxy, written in Python.
1+
# tinyproxy_exporter
2+
3+
A simple Prometheus exporter for Tinyproxy.
4+
5+
## Usage
6+
7+
```
8+
$ pip install -r requirements.txt
9+
$ python3 tinyproxy_exporter --help
10+
usage: tinyproxy_exporter [-h] [-l LISTEN] [-s STATHOST] [-t TINYPROXY]
11+
12+
Prometheus exporter for Tinyproxy.
13+
14+
optional arguments:
15+
-h, --help show this help message and exit
16+
-l LISTEN address on which to expose metrics (default ":9240")
17+
-s STATHOST internal statistics page address (default "tinyproxy.stats")
18+
-t TINYPROXY tinyproxy address (default "127.0.0.1:8888")
19+
```

0 commit comments

Comments
 (0)