`dsetool insights_config`

Enables and disables DataStax Enterprise (DSE) Metrics Collector and configures reporting frequency and storage options. The default mode enables metrics collection and reporting with local storage on disk.

Understand the following requirements before using this command:

At a minimum, you must be running DSE 5.1.14 to use the dsetool insights_config command.
Run this command only on a single node. Changes are propagated to all other nodes in the cluster.
Wait at least 30 seconds for changes to propagate to all nodes.
Restarting DSE is not required.

Synopsis

dsetool insights_config
--show_config | --mode DISABLED|ENABLED_NO_STORAGE|ENABLED_WITH_LOCAL_STORAGE
--metric_sampling_interval_in_seconds seconds
--config_refresh_interval_in_seconds seconds
--data_dir_max_size_in_mb dir_size
--node_system_info_report_period ISO-8601_duration_string

Syntax conventions

Syntax conventions Description

Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
`Italics`	Variable value. Replace with a valid option or user-defined value.
`[ ]`	Optional. Square brackets ( `[ ]` ) surround optional command arguments. Do not type the square brackets.
`( )`	Group. Parentheses ( `( )` ) identify a group to choose from. Do not type the parentheses.
`\|`	Or. A vertical bar ( `\|` ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
`...`	Repeatable. An ellipsis ( `...` ) indicates that you can repeat the syntax element as often as required.
`'Literal string'`	Single quotation ( `'` ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
`{ key:value }`	Map collection. Braces ( `{ }` ) enclose map collections or key value pairs. A colon separates the key and the value.
`<datatype1,datatype2>`	Set, list, map, or tuple. Angle brackets ( `< >` ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
`cql_statement;`	End CQL statement. A semicolon ( `;` ) terminates all CQL statements.
`[ -- ]`	Separate the command line options from the command arguments with two hyphens ( `--` ). This syntax is useful when arguments might be mistaken for command line options.
`' <schema> … </schema> '`	Search CQL only: Single quotation marks ( `'` ) surround an entire XML schema declaration.
`@xml_entity='xml_entity_type'`	Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

UPPERCASE

Literal keyword.

Lowercase

Not literal.

Italics

Variable value. Replace with a valid option or user-defined value.

[ ]

Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.

( )

Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.

|

Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.

...

Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.

'Literal string'

Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.

{ key:value }

Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.

<datatype1,datatype2>

Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.

cql_statement;

End CQL statement. A semicolon ( ; ) terminates all CQL statements.

[ -- ]

Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.

' <schema> … </schema> '

Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.

@xml_entity='xml_entity_type'

Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

--show_config

Prints the current configuration for DSE Metrics Collector.

--mode DISABLED | ENABLED_NO_STORAGE | ENABLED_WITH_LOCAL_STORAGE

Enables and disables DSE Metrics Collector and configures storage options:

DISABLED - disables metrics collection. Default.
ENABLED_NO_STORAGE - enables metrics collection and starts reporting metrics. Typically used when collectd is configured to report to a real-time monitoring system.
ENABLED_WITH_LOCAL_STORAGE - enables metrics collection and reporting with local storage on disk. The default local data directory is /var/lib/cassandra/insights_data. Default.

--metric_sampling_interval_in_seconds seconds

The frequency that metrics are reported to DSE Metrics Collector.

Default: 30

--config_refresh_interval_in_seconds seconds

How often the DSE Metrics Collector configuration changes are pushed to all nodes in the cluster. If nodes are down when a change is made, the change propagates when the node is back up.

Default: 30

--data_dir_max_size_in_mb mb

When local storage is enabled, the limit on how much DSE Metrics Collector data is stored on disk. The maximum size of tmustanot directory cannot exceed 2 GB.

Default: 1024 (1 GB)

--node_system_info_report_period duration

The repeating time interval, in ISO-8601 format, for gathering diagnostic information about the node. For example, PT1H is 1 hour, PT5M is 5 minutes, and PTM200S is 200 seconds.

Default: PT1H (1 hour)

Examples

View the current DSE Metrics Collector configuration

dsetool insights_config --show_config

The results of the default configuration:

{
  "mode" : "DISABLED",
  "config_refresh_interval_in_seconds" : 30,
  "metric_sampling_interval_in_seconds" : 30,
  "data_dir_max_size_in_mb" : 1024,
  "node_system_info_report_period" : "PT1H"
}

Enable metrics collection when collectd is configured to report to a real-time monitoring system

dsetool insights_config --mode ENABLED_NO_STORAGE

Enable metrics collection with local storage

dsetool insights_config --mode ENABLED_WITH_LOCAL_STORAGE

Configure 1500 MB for the DSE Metrics Collector local data directory

dsetool insights_config --data_dir_max_size_in_mb 1500

The maximum size of the local data directory must not exceed 2 GB.

The default directory for local storage is /var/lib/cassandra/insights_data. To change the directory to store collected metrics, see Configuring the data and log directories for DSE Metrics Collector.

Change the node system reporting duration to 1 week

Use an ISO-8601 time duration string.

dsetool insights_config --node_system_info_report_period P1W

Disable metrics collection

dsetool insights_config --mode DISABLED

Configure the metric sampling interval for 60 seconds

dsetool insights_config --metric_sampling_interval_in_seconds 60

Configure 120 seconds for the configuration refresh interval

Push configuration changes to all nodes in the cluster every 2 minutes:

dsetool insights_config --config_refresh_interval_in_seconds 120

After you make configuration changes with dsetool insights_config, you must disable and then re-enable DSE Metrics Collector to read the configuration file again. Wait at least 30 seconds for the changes to propagate to all nodes.

`dsetool insights_config`

Synopsis

Examples

View the current DSE Metrics Collector configuration

Enable metrics collection when collectd is configured to report to a real-time monitoring system

Enable metrics collection with local storage

Configure 1500 MB for the DSE Metrics Collector local data directory

Change the node system reporting duration to 1 week

Disable metrics collection

Configure the metric sampling interval for 60 seconds

Configure 120 seconds for the configuration refresh interval

Was this helpful?

Give Feedback