Skip to content

Commit 6888e85

Browse files
martabalmartabal
committed
chore: mention the new metric in readme
1 parent 54d8b1d commit 6888e85

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

‎README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -116,29 +116,29 @@ Docker compressed size is ~10 MB.
116116

117117
### Environment variables
118118

119-
| Parameter | Function | Default Value |
120-
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
121-
| `-p 8090` | Webservice port | |
122-
| `-e QBITTORRENT_USERNAME` | qBittorrent username | `admin` |
123-
| `-e QBITTORRENT_PASSWORD` | qBittorrent password | `adminadmin` |
124-
| `-e QBITTORRENT_BASE_URL` | qBittorrent base URL | `http://localhost:8090` |
125-
| `-e QBITTORRENT_BASIC_AUTH_USERNAME` | Send basic auth username request header (only if username or password are set) | |
126-
| `-e QBITTORRENT_BASIC_AUTH_PASSWORD` | Send basic auth password request header (only if username or password are set) | |
127-
| `-e QBITTORRENT_TIMEOUT` | Duration before ending a request to qBittorrent | `30` |
128-
| `-e EXPORTER_PORT` | qBittorrent export port (optional) | `8090` |
129-
| `-e EXPORTER_BASIC_AUTH_USERNAME` | Use basic auth (only if username and password are set) | |
130-
| `-e EXPORTER_BASIC_AUTH_PASSWORD` | Use basic auth (only if username and password are set) | |
131-
| `-e LOG_LEVEL` | App log level (`DEBUG`, `INFO`, `WARN`, `ERROR`) | `INFO` |
132-
| `-e ENABLE_TRACKER` | Get tracker info | `true` |
133-
| `-e ENABLE_HIGH_CARDINALITY` | Enable high cardinality metric (`qbittorrent_torrent_info`, `qbittorrent_tracker_info`) | `false` |
134-
| `-e ENABLE_LABEL_WITH_HASH` | **[EXPERIMENTAL]** Add the torrent hash to `qbittorrent_torrent_*` metrics label | `false` |
135-
| `-e EXPORTER_URL` | The URL shown in the logs when starting the exporter | |
136-
| `-e EXPORTER_PATH` | The path where the metrics are exposed | `/metrics` |
137-
| `-e DANGEROUS_SHOW_PASSWORD` | Show the qBittorrent password in logs when starting the exporter | `false` |
138-
| `-e CERTIFICATE_AUTHORITY_PATH` | Path to a CA (`.crt`) used to verify the qBittorrent TLS certificate | |
139-
| `-e INSECURE_SKIP_VERIFY` | Don't validate the TLS certificate presented by qBittorrent | `false` |
140-
| `-e MIN_TLS_VERSION` | Only connect to qBittorrent if it supports at least this TLS version | `TLS_1_3` |
141-
| `-e ENABLE_INCREASED_CARDINALITY` | Enable high cardinality metric (`qbittorrent_torrent_save_path`, `qbittorrent_torrent_state`, `qbittorrent_torrent_comment`) | `false` |
119+
| Parameter | Function | Default Value |
120+
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
121+
| `-p 8090` | Webservice port | |
122+
| `-e QBITTORRENT_USERNAME` | qBittorrent username | `admin` |
123+
| `-e QBITTORRENT_PASSWORD` | qBittorrent password | `adminadmin` |
124+
| `-e QBITTORRENT_BASE_URL` | qBittorrent base URL | `http://localhost:8090` |
125+
| `-e QBITTORRENT_BASIC_AUTH_USERNAME` | Send basic auth username request header (only if username or password are set) | |
126+
| `-e QBITTORRENT_BASIC_AUTH_PASSWORD` | Send basic auth password request header (only if username or password are set) | |
127+
| `-e QBITTORRENT_TIMEOUT` | Duration before ending a request to qBittorrent | `30` |
128+
| `-e EXPORTER_PORT` | qBittorrent export port (optional) | `8090` |
129+
| `-e EXPORTER_BASIC_AUTH_USERNAME` | Use basic auth (only if username and password are set) | |
130+
| `-e EXPORTER_BASIC_AUTH_PASSWORD` | Use basic auth (only if username and password are set) | |
131+
| `-e LOG_LEVEL` | App log level (`DEBUG`, `INFO`, `WARN`, `ERROR`) | `INFO` |
132+
| `-e ENABLE_TRACKER` | Get tracker info | `true` |
133+
| `-e ENABLE_HIGH_CARDINALITY` | Enable high cardinality metric (`qbittorrent_torrent_info`, `qbittorrent_tracker_info`) | `false` |
134+
| `-e ENABLE_LABEL_WITH_HASH` | **[EXPERIMENTAL]** Add the torrent hash to `qbittorrent_torrent_*` metrics label | `false` |
135+
| `-e EXPORTER_URL` | The URL shown in the logs when starting the exporter | |
136+
| `-e EXPORTER_PATH` | The path where the metrics are exposed | `/metrics` |
137+
| `-e DANGEROUS_SHOW_PASSWORD` | Show the qBittorrent password in logs when starting the exporter | `false` |
138+
| `-e CERTIFICATE_AUTHORITY_PATH` | Path to a CA (`.crt`) used to verify the qBittorrent TLS certificate | |
139+
| `-e INSECURE_SKIP_VERIFY` | Don't validate the TLS certificate presented by qBittorrent | `false` |
140+
| `-e MIN_TLS_VERSION` | Only connect to qBittorrent if it supports at least this TLS version | `TLS_1_3` |
141+
| `-e ENABLE_INCREASED_CARDINALITY` | Enable high cardinality metric (`qbittorrent_torrent_info`, `qbittorrent_torrent_save_path`, `qbittorrent_torrent_state`, `qbittorrent_torrent_comment`) | `false` |
142142

143143
### Arguments
144144

0 commit comments

Comments
 (0)