Merge pull request #158 from influxdata/configuration-options

Configuration options
pull/159/head
Scott Anderson 2019-04-12 15:01:54 -06:00 committed by GitHub
commit 0d35ff6dd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 165 additions and 2 deletions

View File

@ -15,6 +15,7 @@ preserveTaxonomyNames = true
# Markdown rendering options
[blackfriday]
hrefTargetBlank = true
smartDashes = false
# Menu items without actual pages
[menu]

View File

@ -8,7 +8,7 @@ v2.0/tags: [cli]
menu:
v2_0_ref:
name: Command line tools
weight: 2
weight: 3
---
InfluxDB provides command line tools designed to aid in managing and working

View File

@ -0,0 +1,162 @@
---
title: InfluxDB configuration options
description:
menu:
v2_0_ref:
name: Configuration options
weight: 2
---
To configure InfluxDB, use the following configuration options when starting the
[`influxd` service](/v2.0/reference/cli/influxd):
- [--assets-path](#assets-path)
- [--bolt-path](#bolt-path)
- [--e2e-testing](#e2e-testing)
- [--engine-path](#engine-path)
- [--http-bind-address](#http-bind-address)
- [--log-level](#log-level)
- [--reporting-disabled](#reporting-disabled)
- [--secret-store](#secret-store)
- [--store](#store)
- [--tracing-type](#tracing-type)
```sh
influxd \
--assets-path=/path/to/custom/assets-dir \
--bolt-path=~/.influxdbv2/influxd.bolt \
--e2e-testing \
--engine-path=~/.influxdbv2/engine \
--http-bind-address=:9999 \
--log-level=info \
--reporting-disabled \
--secret-store=bolt \
--store=bolt \
--tracing-type=log
```
---
## --assets-path
_Typically, InfluxData internal use only._
Overrides the default InfluxDB user interface (UI) assets by serving assets from the specified directory.
```sh
influxd --assets-path=/path/to/custom/assets-dir
```
---
## --bolt-path
Defines the path to the [BoltDB](https://github.com/boltdb/bolt) database.
BoltDB is a key value store written in Go.
InfluxDB uses BoltDB to store data including organization and
user information, UI data, REST resources, and other key value data.
**Default:** `~/.influxdbv2/influxd.bolt`
```sh
influxd --bolt-path=~/.influxdbv2/influxd.bolt
```
---
## --e2e-testing
Adds a `/debug/flush` endpoint to the InfluxDB HTTP API to clear stores.
InfluxData uses this endpoint in end-to-end testing.
```sh
influxd --e2e-testing
```
---
## --engine-path
Defines the path to persistent storage engine files where InfluxDB stores all
Time-Structure Merge Tree (TSM) data on disk.
**Default:** `~/.influxdbv2/engine`
```sh
influxd --engine-path=~/.influxdbv2/engine
```
---
## --http-bind-address
Defines the bind address for the InfluxDB HTTP API.
Customize the URL and port for the InfluxDB API and UI.
**Default:** `:9999`
```sh
influxd --http-bind-address=:9999
```
---
## --log-level
Defines the log output level.
InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
**Options:** `debug`, `info`, `error`
**Default:** `info`
```sh
influxd --log-level=info
```
---
## --reporting-disabled
Disables sending telemetry data to InfluxData.
The [InfluxData telemetry](https://www.influxdata.com/telemetry) page provides
information about what data is collected and how InfluxData uses it.
```sh
influxd --reporting-disabled
```
---
## --secret-store
Specifies the data store for secrets such as passwords and tokens.
Store secrets in either the InfluxDB [internal BoltDB](#bolt-path)
or in [Vault](https://www.vaultproject.io/).
**Options:** `bolt`, `vault`
**Default:** `bolt`
```sh
influxd --secret-store=bolt
```
---
## --store
Specifies the data store for REST resources.
**Options:** `bolt`, `memory`
**Default:** `bolt`
{{% note %}}
`memory` is meant for transient environments, such as testing environments, where
data persistence does not matter.
InfluxData does not recommend using `memory` in production.
{{% /note %}}
```sh
influxd --store=bolt
```
---
## --tracing-type
Enables tracing in InfluxDB and specifies the tracing type.
Tracing is disabled by default.
**Options:** `log`, `jaeger`
```sh
influxd --tracing-type=log
```

View File

@ -5,7 +5,7 @@ v2.0/tags: [flux]
menu:
v2_0_ref:
name: Flux query language
weight: 3
weight: 4
---
The following articles are meant as a reference for Flux functions and the