Skip to content

Commit 18ddbe3

Browse files
authored
Update README.md
1 parent 01ded0f commit 18ddbe3

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
## Description
99
MKTXP is a Prometheus Exporter for Mikrotik RouterOS devices.\
10-
It gathers and exports a rich set of metrics and configurable data transformations across multiple routers, all easily configurable via built-in CLI interface.
10+
It gathers and exports a rich set of metrics across multiple routers, all easily configurable via built-in CLI interface.
1111

12-
Apart from exporting to Prometheus, MKTXP can also print some of the metrics directly on the command line (see an example below).
12+
Apart from exporting to Prometheus, MKTXP can also print selected metrics directly on the command line (see an example below).
1313

1414
For effortless visualization of the RouterOS metrics exported to Prometheus, MKTXP comes with a dedicated [Grafana dashboard](https://grafana.com/grafana/dashboards/13679):
1515

@@ -87,7 +87,7 @@ The default configuration file comes with a sample configuration, making it easy
8787
user = True # Active Users metrics
8888
queue = True # Queues metrics
8989
90-
remote_dhcp_entry = None # An MKTXP entry for remote DHCP info resolution (capsman/wireless)
90+
remote_dhcp_entry = None # An MKTXP entry for remote DHCP info resolution in capsman/wireless
9191
9292
use_comments_over_names = True # when available, forces using comments over the interfaces names
9393
```
@@ -333,6 +333,12 @@ mktxp is running as pid 36704
333333
````
334334
❯ mktxp -h
335335
usage: MKTXP [-h] [--cfg-dir CFG_DIR] {info, edit, export, print, show, } ...
336+
337+
Prometheus Exporter for Mikrotik RouterOS
338+
339+
optional arguments:
340+
-h, --help show this help message and exit
341+
--cfg-dir CFG_DIR MKTXP config files directory (optional)
336342
````
337343
To learn more about individual commands, just run it with ```-h```:
338344
For example, to learn everything about ````mktxp show````:

0 commit comments

Comments
 (0)