Skip to content
This repository was archived by the owner on Feb 16, 2020. It is now read-only.

Commit d1da163

Browse files
committed
#7: Formats the variables in README.md
1 parent c383fe2 commit d1da163

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,17 @@ docker run --rm -it -p 9308:9308 \
1919
```
2020

2121
## Supported variables:
22-
* `API_KEY` (no default - **mandatory**) - set this to your Etherscan API key
23-
* `URL` (default: https://api.etherscan.io/api) - set this to your Etherscan API secret
24-
* `ADDRESSES` (no default) - a comma separated list of the ETH addresses to export
25-
* `TOKENS` (no default) - a JSON object with the list of tokens to export (see below)
26-
* `GELF_HOST` (no default) - if set, the exporter will also log to this [GELF](https://docs.graylog.org/en/3.0/pages/gelf.html) capable host on UDP
27-
* `GELF_PORT` (defaults to `12201`) - the port to use for GELF logging
28-
* `PORT` (defaults to `9308`) - the listen port for the exporter
29-
* `LOGLEVEL` (defaults to `INFO`)
22+
23+
| **Variable** | **Default** | **Mandatory** | **Description** |
24+
|:-------------|:------------------------------:|:-------------:|:-----------------|
25+
| `API_KEY` | - | **YES** | set this to your Etherscan API key |
26+
| `URL` | `https://api.etherscan.io/api` | NO | The URL of the Etherscan API |
27+
| `ADDRESSES` | - | NO | A comma separated list of the ETH addresses to export |
28+
| `TOKENS` | - | NO | A JSON object with the list of tokens to export (see [below](#tokens-variable)) |
29+
| `LOGLEVEL` | `INFO` | NO | [Logging Level](https://docs.python.org/3/library/logging.html#levels) |
30+
| `GELF_HOST` | - | NO | If set, the exporter will also log to this [GELF](https://docs.graylog.org/en/3.0/pages/gelf.html) capable host on UDP |
31+
| `GELF_PORT` | `12201` | NO | Ignored, if `GELF_HOST` is unset. The UDP port for GELF logging |
32+
| `PORT` | `9308` | NO | The port for prometheus metrics |
3033

3134
## Tokens variable:
3235
Example:

0 commit comments

Comments
 (0)