Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add storage flags and realign table (addresses #1523)

pull/1537/head
noramullen1 2020-09-23 11:46:51 -07:00
parent b128d5a571
commit 99c89af433
1 changed files with 47 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
layouts/shortcodes/cli/influxd-flags.md
View File

@ -1,35 +1,47 @@
| Flag | | Description | Input type | Mapped to |
|:---- |:--- |:----------- | :--------: |:--------- |
| | `--assets-path` | Override default assets by serving from a specific directory (developer mode) | string | `INFLUXD_ASSETS_PATH` |
| | `--bolt-path` | Path to boltdb database (default `~/.influxdbv2/influxd.bolt`) | string | `INFLUXD_BOLT_PATH` |
| | `--e2e-testing` | Add /debug/flush endpoint to clear stores; used for end-to-end tests (default `false`) | | `INFLUXD_E2E_TESTING` |
| | `--engine-path` | Path to persistent engine files (default `~/.influxdbv2/engine`) | string | `INFLUXD_ENGINE_PATH` |
| `-h` | `--help` | Help for the `influxd` command | | |
| | `--http-bind-address` | Bind address for the REST HTTP API (default `:8086`) | string | `INFLUXD_HTTP_BIND_ADDRESS` |
| | `--log-level` | Supported log levels are debug, info, and error (default `info`) | string | `INFLUXD_LOG_LEVEL` |
| | `--new-meta-store` | Enables the new meta store | | `INFLUXD_NEW_META_STORE` |
| | `--new-meta-store-read-only` | Toggle read-only mode for the new meta store and duplicate reads between old and new store (default `true`) | | `INFLUXD_NEW_META_STORE_READ_ONLY` |
| | `--no-tasks` | Disables the task scheduler | | `INFLUXD_NO_TASKS` |
| | `--query-concurrency` | Number of queries allowed to execute concurrently (default `10`) | integer | `INFLUXD_QUERY_CONCURRENCY` |
| | `--query-initial-memory-bytes` | Initial bytes of memory allocated for a query (default = `query-memory-bytes`) | integer | `INFLUXD_QUERY_INITIAL_MEMORY_BYTES` |
| | `--query-max-memory-bytes` | Maximum total bytes of memory allowed for queries (default = `query-concurrency` × `query-memory-bytes`) | integer | `INFLUXD_QUERY_MAX_MEMORY_BYTES` |
| | `--query-memory-bytes` | Maximum bytes of memory allowed for a single query (default _unlimited_, must be >= `query-initial-memory-bytes`) | integer | `INFLUXD_QUERY_MEMORY_BYTES` |
| | `--query-queue-size` | Maximum number of queries allowed in execution queue (default `10`) | integer | `INFLUXD_QUERY_QUEUE_SIZE` |
| | `--reporting-disabled` | Disable sending telemetry data to **https:<nolink>//telemetry.influxdata.com** | | `INFLUXD_REPORTING_DISABLED` |
| | `--secret-store` | Data store for secrets (bolt or vault) (default `bolt`) | string | `INFLUXD_SECRET_STORE` |
| | `--session-length` | TTL in minutes for newly created sessions (default `60`) | integer | `INFLUXD_SESSION_LENGTH` |
| | `--session-renew-disabled` | Disables automatically extending session TTL on request | | `INFLUXD_SESSION_RENEW_DISABLED` |
| | `--store` | Data store for REST resources (bolt or memory) (default `bolt`) | string | `INFLUXD_STORE` |
| | `--tls-cert` | Path to TLS certificate file | string | `INFLUXD_TLS_CERT` |
| | `--tls-key` | Path to TLS private key file | string | `INFLUXD_TLS_KEY` |
| | `--tracing-type` | Supported tracing types (log or jaeger) | string | `INFLUXD_TRACING_TYPE` |
| | `--vault-addr ` | Address of the Vault server (example: `https://127.0.0.1:8200/`) | string | `VAULT_ADDR` |
| | `--vault-cacert` | Path to a PEM-encoded CA certificate file | string | `VAULT_CACERT` |
| | `--vault-capath` | Path to a directory of PEM-encoded CA certificate files | string | `VAULT_CAPATH` |
| | `--vault-client-cert` | Path to a PEM-encoded client certificate | string | `VAULT_CLIENT_CERT` |
| | `--vault-client-key` | Path to an unencrypted, PEM-encoded private key which corresponds to the matching client certificate | string | `VAULT_CLIENT_KEY` |
| | `--vault-max-retries` | Maximum number of retries when encountering a 5xx error code (default `2`) | integer | `VAULT_MAX_RETRIES` |
| | `--vault-client-timeout` | Vault client timeout (default `60s`) | duration | `VAULT_CLIENT_TIMEOUT` |
| | `--vault-skip-verify` | Skip certificate verification when communicating with Vault | | `VAULT_SKIP_VERIFY` |
| | `--vault-tls-server-name` | Name to use as the SNI host when connecting to Vault via TLS | string | `VAULT_TLS_SERVER_NAME` |
| | `--vault-token` | Vault authentication token | string | `VAULT_TOKEN` |
| Flag | | Description | Input type | Mapped to |
|------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|--------------------------------------|
| | `--assets-path` | Override default assets by serving from a specific directory (developer mode) | string | `INFLUXD_ASSETS_PATH` |
| | `--bolt-path` | Path to boltdb database (default `~/.influxdbv2/influxd.bolt`) | string | `INFLUXD_BOLT_PATH` |
| | `--e2e-testing` | Add /debug/flush endpoint to clear stores; used for end-to-end tests (default `false`) | | `INFLUXD_E2E_TESTING` |
| | `--engine-path` | Path to persistent engine files (default `~/.influxdbv2/engine`) | string | `INFLUXD_ENGINE_PATH` |
| `-h` | `--help` | Help for the `influxd` command | | |
| | `--http-bind-address` | Bind address for the REST HTTP API (default `:8086`) | string | `INFLUXD_HTTP_BIND_ADDRESS` |
| | `--log-level` | Supported log levels are debug, info, and error (default `info`) | string | `INFLUXD_LOG_LEVEL` |
| | `--new-meta-store` | Enables the new meta store | | `INFLUXD_NEW_META_STORE` |
| | `--new-meta-store-read-only` | Toggle read-only mode for the new meta store and duplicate reads between old and new store (default `true`) | | `INFLUXD_NEW_META_STORE_READ_ONLY` |
| | `--no-tasks` | Disables the task scheduler | | `INFLUXD_NO_TASKS` |
| | `--query-concurrency` | Number of queries allowed to execute concurrently (default `10`) | integer | `INFLUXD_QUERY_CONCURRENCY` |
| | `--query-initial-memory-bytes` | Initial bytes of memory allocated for a query (default = `query-memory-bytes`) | integer | `INFLUXD_QUERY_INITIAL_MEMORY_BYTES` |
| | `--query-max-memory-bytes` | Maximum total bytes of memory allowed for queries (default = `query-concurrency` × `query-memory-bytes`) | integer | `INFLUXD_QUERY_MAX_MEMORY_BYTES` |
| | `--query-memory-bytes` | Maximum bytes of memory allowed for a single query (default _unlimited_, must be >= `query-initial-memory-bytes`) | integer | `INFLUXD_QUERY_MEMORY_BYTES` |
| | `--query-queue-size` | Maximum number of queries allowed in execution queue (default `10`) | integer | `INFLUXD_QUERY_QUEUE_SIZE` |
| | `--reporting-disabled` | Disable sending telemetry data to **https://telemetry.influxdata.com** | | `INFLUXD_REPORTING_DISABLED` |
| | `--secret-store` | Data store for secrets (bolt or vault) (default `bolt`) | string | `INFLUXD_SECRET_STORE` |
| | `--session-length` | TTL in minutes for newly created sessions (default `60`) | integer | `INFLUXD_SESSION_LENGTH` |
| | `--session-renew-disabled` | Disables automatically extending session TTL on request | | `INFLUXD_SESSION_RENEW_DISABLED` |
| | `--store` | Data store for REST resources (bolt or memory) (default `bolt`) | string | `INFLUXD_STORE` |
| | `--tls-cert` | Path to TLS certificate file | string | `INFLUXD_TLS_CERT` |
| | `--tls-key` | Path to TLS private key file | string | `INFLUXD_TLS_KEY` |
| | `--tracing-type` | Supported tracing types (log or jaeger) | string | `INFLUXD_TRACING_TYPE` |
| | `--vault-addr ` | Address of the Vault server (example: `https://127.0.0.1:8200/`) | string | `VAULT_ADDR` |
| | `--vault-cacert` | Path to a PEM-encoded CA certificate file | string | `VAULT_CACERT` |
| | `--vault-capath` | Path to a directory of PEM-encoded CA certificate files | string | `VAULT_CAPATH` |
| | `--vault-client-cert` | Path to a PEM-encoded client certificate | string | `VAULT_CLIENT_CERT` |
| | `--vault-client-key` | Path to an unencrypted, PEM-encoded private key which corresponds to the matching client certificate | string | `VAULT_CLIENT_KEY` |
| | `--vault-max-retries` | Maximum number of retries when encountering a 5xx error code (default `2`) | integer | `VAULT_MAX_RETRIES` |
| | `--vault-client-timeout` | Vault client timeout (default `60s`) | duration | `VAULT_CLIENT_TIMEOUT` |
| | `--vault-skip-verify` | Skip certificate verification when communicating with Vault | | `VAULT_SKIP_VERIFY` |
| | `--vault-tls-server-name` | Name to use as the SNI host when connecting to Vault via TLS | string | `VAULT_TLS_SERVER_NAME` |
| | `--vault-token` | Vault authentication token | string | `VAULT_TOKEN` |
| | `--storage-cache-max-memory-size` | Maximum size a shard's cache can reach before it starts rejecting writes. (default `1.0 GiB`) | integer | |
| | `--storage-cache-snapshot-memory-size` | Size at which the engine will snapshot the cache and write it to a TSM file, freeing up memory (default `25 MiB`) | integer | |
| | `--storage-cache-snapshot-write-cold-duration` | Length of time at which the engine will snapshot the cache and write it to a new TSM file if the shard hasn't received writes or deletes (default `10m0s`) | duration | |
| | `--storage-compact-full-write-cold-duration` | Duration at which the engine will compact all TSM files in a shard if it hasn't received writes or deletes (default `4h0m0s`) | duration | |
| | `--storage-compact-throughput-burst` | Rate limit in bytes per second that TSM compactions can write to disk (default `48 MiB`) | integer | |
| | `--storage-max-concurrent-compactions` | Maximum number of concurrent full and level compactions that can run at one time. A value of 0 results in 50% of runtime. `GOMAXPROCS(0)` used at runtime. Any number greater than 0 limits compactions to that value. This setting does not apply to cache snapshotting. | integer | |
| | `--storage-max-index-log-file-size` | Threshold, in bytes, when an index write-ahead log file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput (default `1.0 MiB`) | integer | |
| | `--storage-series-file-max-concurrent-snapshot-compactions` | Maximum number of concurrent snapshot compactions that can be running at one time across all series partitions in a database | integer | |
| | `--storage-series-id-set-cache-size` | Size of the internal cache used in the TSI index to store previously calculated series results | integer | |
| | `--storage-tsm-use-madv-willneed` | Controls whether we hint to the kernel that we intend to page in mmap'd sections of TSM files | | |
| | `--storage-validate-keys` | Validates incoming writes to ensure keys only have valid unicode characters | | |
| | `--storage-wal-fsync-delay` | Amount of time that a write will wait before fsyncing. A duration greater than 0 can be used to batch up multiple fsync calls. This is useful for slower disks or when WAL write contention is seen. (default `0s`) | duration | |