Struct InfluxDBv2Parameters 

#[non_exhaustive]
pub struct InfluxDBv2Parameters {

    pub flux_log_enabled: Option<bool>,
    pub log_level: Option<LogLevel>,
    pub no_tasks: Option<bool>,
    pub query_concurrency: Option<i32>,
    pub query_queue_size: Option<i32>,
    pub tracing_type: Option<TracingType>,
    pub metrics_disabled: Option<bool>,
    pub http_idle_timeout: Option<Duration>,
    pub http_read_header_timeout: Option<Duration>,
    pub http_read_timeout: Option<Duration>,
    pub http_write_timeout: Option<Duration>,
    pub influxql_max_select_buckets: Option<i64>,
    pub influxql_max_select_point: Option<i64>,
    pub influxql_max_select_series: Option<i64>,
    pub pprof_disabled: Option<bool>,
    pub query_initial_memory_bytes: Option<i64>,
    pub query_max_memory_bytes: Option<i64>,
    pub query_memory_bytes: Option<i64>,
    pub session_length: Option<i32>,
    pub session_renew_disabled: Option<bool>,
    pub storage_cache_max_memory_size: Option<i64>,
    pub storage_cache_snapshot_memory_size: Option<i64>,
    pub storage_cache_snapshot_write_cold_duration: Option<Duration>,
    pub storage_compact_full_write_cold_duration: Option<Duration>,
    pub storage_compact_throughput_burst: Option<i64>,
    pub storage_max_concurrent_compactions: Option<i32>,
    pub storage_max_index_log_file_size: Option<i64>,
    pub storage_no_validate_field_size: Option<bool>,
    pub storage_retention_check_interval: Option<Duration>,
    pub storage_series_file_max_concurrent_snapshot_compactions: Option<i32>,
    pub storage_series_id_set_cache_size: Option<i64>,
    pub storage_wal_max_concurrent_writes: Option<i32>,
    pub storage_wal_max_write_delay: Option<Duration>,
    pub ui_disabled: Option<bool>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flux_log_enabled: Option<bool>

Include option to show detailed logs for Flux queries.

Default: false

log_level: Option<LogLevel>

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

Default: info

no_tasks: Option<bool>

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

Default: false

query_concurrency: Option<i32>

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

Default: 0

query_queue_size: Option<i32>

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

tracing_type: Option<TracingType>

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

metrics_disabled: Option<bool>

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

Default: false

http_idle_timeout: Option<Duration>

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

Default: 3 minutes

http_read_header_timeout: Option<Duration>

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

Default: 10 seconds

http_read_timeout: Option<Duration>

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

Default: 0

http_write_timeout: Option<Duration>

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

Default: 0

influxql_max_select_buckets: Option<i64>

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

Default: 0

influxql_max_select_point: Option<i64>

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

influxql_max_select_series: Option<i64>

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

Default: 0

pprof_disabled: Option<bool>

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

Default: true

query_initial_memory_bytes: Option<i64>

Initial bytes of memory allocated for a query.

Default: 0

query_max_memory_bytes: Option<i64>

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

query_memory_bytes: Option<i64>

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

Default: 0

session_length: Option<i32>

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

Default: 60

session_renew_disabled: Option<bool>

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

storage_cache_max_memory_size: Option<i64>

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

storage_cache_snapshot_memory_size: Option<i64>

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

storage_cache_snapshot_write_cold_duration: Option<Duration>

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

storage_compact_full_write_cold_duration: Option<Duration>

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

storage_compact_throughput_burst: Option<i64>

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

Default: 50331648

storage_max_concurrent_compactions: Option<i32>

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

storage_max_index_log_file_size: Option<i64>

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

storage_no_validate_field_size: Option<bool>

Skip field size validation on incoming write requests.

Default: false

storage_retention_check_interval: Option<Duration>

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

Default: 30 minutes

storage_series_file_max_concurrent_snapshot_compactions: Option<i32>

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

Default: 0

storage_series_id_set_cache_size: Option<i64>

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

storage_wal_max_concurrent_writes: Option<i32>

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

storage_wal_max_write_delay: Option<Duration>

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

ui_disabled: Option<bool>

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

Default: false

Implementations

impl InfluxDBv2Parameters

pub fn flux_log_enabled(&self) -> Option<bool>

Include option to show detailed logs for Flux queries.

Default: false

pub fn log_level(&self) -> Option<&LogLevel>

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

Default: info

pub fn no_tasks(&self) -> Option<bool>

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

Default: false

pub fn query_concurrency(&self) -> Option<i32>

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

Default: 0

pub fn query_queue_size(&self) -> Option<i32>

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

pub fn tracing_type(&self) -> Option<&TracingType>

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

pub fn metrics_disabled(&self) -> Option<bool>

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

Default: false

pub fn http_idle_timeout(&self) -> Option<&Duration>

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

Default: 3 minutes

pub fn http_read_header_timeout(&self) -> Option<&Duration>

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

Default: 10 seconds

pub fn http_read_timeout(&self) -> Option<&Duration>

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

Default: 0

pub fn http_write_timeout(&self) -> Option<&Duration>

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

Default: 0

pub fn influxql_max_select_buckets(&self) -> Option<i64>

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

Default: 0

pub fn influxql_max_select_point(&self) -> Option<i64>

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

pub fn influxql_max_select_series(&self) -> Option<i64>

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

Default: 0

pub fn pprof_disabled(&self) -> Option<bool>

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

Default: true

pub fn query_initial_memory_bytes(&self) -> Option<i64>

Initial bytes of memory allocated for a query.

Default: 0

pub fn query_max_memory_bytes(&self) -> Option<i64>

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

pub fn query_memory_bytes(&self) -> Option<i64>

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

Default: 0

pub fn session_length(&self) -> Option<i32>

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

Default: 60

pub fn session_renew_disabled(&self) -> Option<bool>

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

pub fn storage_cache_max_memory_size(&self) -> Option<i64>

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

pub fn storage_cache_snapshot_memory_size(&self) -> Option<i64>

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

pub fn storage_cache_snapshot_write_cold_duration(&self) -> Option<&Duration>

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

pub fn storage_compact_full_write_cold_duration(&self) -> Option<&Duration>

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

pub fn storage_compact_throughput_burst(&self) -> Option<i64>

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

Default: 50331648

pub fn storage_max_concurrent_compactions(&self) -> Option<i32>

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

pub fn storage_max_index_log_file_size(&self) -> Option<i64>

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

pub fn storage_no_validate_field_size(&self) -> Option<bool>

Skip field size validation on incoming write requests.

Default: false

pub fn storage_retention_check_interval(&self) -> Option<&Duration>

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

Default: 30 minutes

pub fn storage_series_file_max_concurrent_snapshot_compactions( &self, ) -> Option<i32>

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

Default: 0

pub fn storage_series_id_set_cache_size(&self) -> Option<i64>

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

pub fn storage_wal_max_concurrent_writes(&self) -> Option<i32>

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

pub fn storage_wal_max_write_delay(&self) -> Option<&Duration>

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

pub fn ui_disabled(&self) -> Option<bool>

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

Default: false

impl InfluxDBv2Parameters

pub fn builder() -> InfluxDBv2ParametersBuilder

Creates a new builder-style object to manufacture InfluxDBv2Parameters.

Trait Implementations

impl Clone for InfluxDBv2Parameters

fn clone(&self) -> InfluxDBv2Parameters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InfluxDBv2Parameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for InfluxDBv2Parameters

fn eq(&self, other: &InfluxDBv2Parameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InfluxDBv2Parameters