Skip to content

Commit

Permalink
docs: update required field for influx (#1198)
Browse files Browse the repository at this point in the history
* docs: update required field for influx
  • Loading branch information
rahulguptajss authored Aug 11, 2022
1 parent 42ef0a4 commit 3be5ad1
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions cmd/exporters/influxdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ If `url` is specified, you must add all arguments to the url.
Harvest will do no additional processing and use exactly what you specify. (e.g. `url: https://influxdb.example.com:8086/write?db=netapp&u=user&p=pass&precision=2`.
When using `url`, the `bucket`, `org`, `port`, and `precision` fields will be ignored.

| parameter | type | description | default |
|------------------|-----------------------------|----------------------------------------------------------------------------------------------------|---------|
| `url` | string | URL of the database, format: `SCHEME://HOST[:PORT]` | |
| `addr` | string | address of the database, format: `HOST` (HTTP only) | |
| `port` | int, optional | port of the database | `8086` |
| `bucket` | string, required with `url` | InfluxDB bucket to write | |
| `org` | string, required with `url` | InfluxDB organization name | |
| `precision` | string, required with `url` | Preferred timestamp precision in seconds | `2` |
| `client_timeout` | int, optional | client timeout in seconds | `5` |
| `token` | string | [token for authentication](https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens/) | |
| parameter | type | description | default |
|------------------|------------------------------|----------------------------------------------------------------------------------------------------|---------|
| `url` | string | URL of the database, format: `SCHEME://HOST[:PORT]` | |
| `addr` | string | address of the database, format: `HOST` (HTTP only) | |
| `port` | int, optional | port of the database | `8086` |
| `bucket` | string, required with `addr` | InfluxDB bucket to write | |
| `org` | string, required with `addr` | InfluxDB organization name | |
| `precision` | string, required with `addr` | Preferred timestamp precision in seconds | `2` |
| `client_timeout` | int, optional | client timeout in seconds | `5` |
| `token` | string | [token for authentication](https://docs.influxdata.com/influxdb/v2.0/security/tokens/view-tokens/) | |

### Example

snippet from `harvest.yml` using `addr`:
snippet from `harvest.yml` using `addr`: (supports HTTP only))

```yaml
Exporters:
Expand All @@ -49,13 +49,13 @@ Exporters:
token: ZTTrt%24@#WNFM2VZTTNNT25wZWUdtUmhBZEdVUmd3dl@#
```
snippet from `harvest.yml` using `url`:
snippet from `harvest.yml` using `url`: (supports both HTTP/HTTPS))

```yaml
Exporters:
influx2:
exporter: InfluxDB
url: http://localhost:8086/api/v2/write?org=harvest&bucket=harvest&precision=s
url: https://localhost:8086/api/v2/write?org=harvest&bucket=harvest&precision=s
token: my-token==
```

Expand Down

0 comments on commit 3be5ad1

Please sign in to comment.