From 93525fd72dee865260f6ecbedb26836fd0c9e863 Mon Sep 17 00:00:00 2001 From: woblerr Date: Thu, 26 Oct 2023 23:56:07 +0300 Subject: [PATCH] Update README. --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f4833cf..72d11b8 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,9 @@ make build ./authlog_exporter ``` -By default, metrics will be collecting from `/var/log/auth.log` and will be available at http://localhost:9991/metrics. This means that the user who runs `authlog_exporter` should have read permission to file `/var/log/auth.log`. You can changed log file location, port and endpoint by using the`--auth.log`, `--prom.port` and `--prom.endpoint` flags. +By default, metrics will be collecting from `/var/log/auth.log` and will be available at http://localhost:9991/metrics. +This means that the user who runs `authlog_exporter` should have read permission to file `/var/log/auth.log`. +You can changed log file location by using the`--auth.log` flag. For geoIP analyze you need to specify `--geo.type` flag: * `db` - for local geoIP database file, @@ -75,8 +77,8 @@ For geoIP analyze you need to specify `--geo.type` flag: For local geoIP database usage you also need specify `--geo.db` flag (path to geoIP database file). -The flag `--prom.web-config` allows to specify the path to the configuration for TLS and/or basic authentication.
-The description of TLS configuration and basic authentication can be found at [exporter-toolkit/web](https://github.com/prometheus/exporter-toolkit/blob/v0.7.1/docs/web-configuration.md). +The flag `--web.config.file` allows to specify the path to the configuration for TLS and/or basic authentication.
+The description of TLS configuration and basic authentication can be found at [exporter-toolkit/web](https://github.com/prometheus/exporter-toolkit/blob/v0.9.1/docs/web-configuration.md). Available configuration flags: @@ -84,24 +86,27 @@ Available configuration flags: ./authlog_exporter --help usage: authlog_exporter [] + Flags: - -h, --help Show context-sensitive help (also try --help-long and --help-man). + -h, --[no-]help Show context-sensitive help (also try --help-long and --help-man). --auth.log="/var/log/auth.log" - Path to auth.log. - --prom.endpoint="/metrics" - Endpoint used for metrics. - --prom.port="9991" Port for prometheus metrics to listen on. - --prom.web-config="" [EXPERIMENTAL] Path to config yaml file that can enable TLS or authentication. - --geo.db="" Path to geoIP database file. - --geo.lang="en" Output language format. - --geo.timeout=2 Timeout in seconds for waiting response from geoIP database API. - --geo.type="" Type of geoIP database: db, url. + Path to auth.log. + --web.endpoint="/metrics" Endpoint used for metrics. + --web.listen-address=:9991 ... + Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. + --web.config.file="" [EXPERIMENTAL] Path to configuration file that can enable TLS or authentication. + --geo.db="" Path to geoIP database file. + --geo.lang="en" Output language format. + --geo.timeout=2 Timeout in seconds for waiting response from geoIP database API. + --geo.type="" Type of geoIP database: db, url. --geo.url="https://reallyfreegeoip.org/json/" - URL for geoIP database API. - --metric.hideip Set this flag to hide IPs in the output and therefore drastically reduce the amount of metrics published. - --metric.hideuser Set this flag to hide user accounts in the output and therefore drastically reduce the amount of metrics published. - --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error] - --log.format=logfmt Output format of log messages. One of: [logfmt, json] + URL for geoIP database API. + --[no-]metric.hideip Set this flag to hide IPs in the output and therefore drastically reduce the amount of metrics + published. + --[no-]metric.hideuser Set this flag to hide user accounts in the output and therefore drastically reduce the amount of metrics + published. + --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error] + --log.format=logfmt Output format of log messages. One of: [logfmt, json] ``` ### geoIP