dsetool insights_config
Enables, disables, and configures reporting frequency and storage options for DSE Metrics Collector.
The default mode enables metrics collection and reporting with local storage on disk.
|
Run this command on one node only. The change is propagated to other nodes in the cluster automatically. Wait at least 30 seconds for the changes to propagate to all nodes. After changing any DSE Metrics Collector configuration settings with You don’t need to restart DSE. |
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 | Description |
|---|---|
Italic, bold, or |
Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value. In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple.
Separate the data types with a comma.
For example: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
Square brackets surround optional command arguments. Do not type the square brackets. |
|
Parentheses identify a group to choose from. Do not type the parentheses. |
|
A pipe separates alternative elements. Type any one of the elements. Do not type the pipe. |
|
Indicates that you can repeat the syntax element as often as required. |
|
Single quotation marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case. For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as |
|
Map collection.
Curly braces enclose maps ( |
|
Ends a CQL statement. |
|
Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options. |
Options
- --show_config
-
Prints the current configuration for DSE Metrics Collector.
- --mode
-
Enables and disables DSE Metrics Collector and configures storage options:
-
DISABLED: Disables metrics collection. -
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(default): Enables metrics collection and reporting with local storage on disk. The default directory for local storage is/var/lib/cassandra/insights_data.
To change the directory to store collected metrics, see DSE Metrics Collector properties in
dse.yaml. -
- --metric_sampling_interval_in_seconds
-
The frequency that metrics are reported to DSE Metrics Collector.
Default:
30 - --config_refresh_interval_in_seconds
-
How often the DSE Metrics Collector configuration changes are pushed to all nodes in the cluster. If a node is down when a change is made, the change will propagate when the node is back up.
Default:
30 - --data_dir_max_size_in_mb
-
When the
--modeisENABLED_WITH_LOCAL_STORAGE, set the limit for DSE Metrics Collector data stored on disk.The maximum size of the local data directory must not exceed 2 GB.
Default:
1024(1 GB) - --node_system_info_report_period
-
The repeating time interval, in ISO-8601 format, for gathering diagnostic information about the node. For example,
PT1His 1 hour,PT5Mis 5 minutes, andPTM200Sis 200 seconds.Default:
PT1H(1 hour)
Examples
- Get the current DSE Metrics Collector configuration
-
dsetool insights_config --show_configThe following example result shows the default configuration:
{ "mode" : "ENABLED_WITH_LOCAL_STORAGE", "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" } - Disable metrics collection
-
dsetool insights_config --mode DISABLED - Enable metrics collection for reporting 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 - Set the DSE Metrics Collector local data directory limit to 1500 MB
-
dsetool insights_config --data_dir_max_size_in_mb 1500 - 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 - Set the metric sampling interval to 60 seconds
-
dsetool insights_config --metric_sampling_interval_in_seconds 60 - Propagate DSE Metrics Collector configuration changes to all nodes every 2 minutes (120 seconds)
-
dsetool insights_config --config_refresh_interval_in_seconds 120