InfluxDBv2Parameters - Timestream for InfluxDB
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

InfluxDBv2Parameters

All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.

Contents

fluxLogEnabled

Include option to show detailed logs for Flux queries.

Default: false

Type: Boolean

Required: No

httpIdleTimeout

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

Default: 3 minutes

Type: Duration object

Required: No

httpReadHeaderTimeout

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

Default: 10 seconds

Type: Duration object

Required: No

httpReadTimeout

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

Default: 0

Type: Duration object

Required: No

httpWriteTimeout

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

Default: 0

Type: Duration object

Required: No

influxqlMaxSelectBuckets

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

Default: 0

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

influxqlMaxSelectPoint

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

Default: 0

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

influxqlMaxSelectSeries

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

Default: 0

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

logLevel

Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.

Default: info

Type: String

Valid Values: debug | info | error

Required: No

metricsDisabled

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

Default: false

Type: Boolean

Required: No

noTasks

Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.

Default: false

Type: Boolean

Required: No

pprofDisabled

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

Default: false

Type: Boolean

Required: No

queryConcurrency

Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.

Default: 0

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 256.

Required: No

queryInitialMemoryBytes

Initial bytes of memory allocated for a query.

Default: 0

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

queryMaxMemoryBytes

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

queryMemoryBytes

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

Default: 0

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

queryQueueSize

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

Default: 0

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 256.

Required: No

sessionLength

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

Default: 60

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 2880.

Required: No

sessionRenewDisabled

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

Default: false

Type: Boolean

Required: No

storageCacheMaxMemorySize

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

Default: 1073741824

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

storageCacheSnapshotMemorySize

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

Default: 26214400

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

storageCacheSnapshotWriteColdDuration

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

Default: 10 minutes

Type: Duration object

Required: No

storageCompactFullWriteColdDuration

Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

Default: 4 hours

Type: Duration object

Required: No

storageCompactThroughputBurst

Rate limit (in bytes per second) that TSM compactions can write to disk.

Default: 50331648

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

storageMaxConcurrentCompactions

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

Default: 0

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 64.

Required: No

storageMaxIndexLogFileSize

Size (in bytes) at which an index write-ahead log (WAL) 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: 1048576

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

storageNoValidateFieldSize

Skip field size validation on incoming write requests.

Default: false

Type: Boolean

Required: No

storageRetentionCheckInterval

Interval of retention policy enforcement checks. Must be greater than 0.

Default: 30 minutes

Type: Duration object

Required: No

storageSeriesFileMaxConcurrentSnapshotCompactions

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

Default: 0

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 64.

Required: No

storageSeriesIdSetCacheSize

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

Default: 100

Type: Long

Valid Range: Minimum value of 0. Maximum value of 1000000000000.

Required: No

storageWalMaxConcurrentWrites

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

Default: 0

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 256.

Required: No

storageWalMaxWriteDelay

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

Default: 10 minutes

Type: Duration object

Required: No

tracingType

Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.

Type: String

Valid Values: log | jaeger

Required: No

uiDisabled

Disable the InfluxDB user interface (UI). The UI is enabled by default.

Default: false

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: