dsetool insights_filters

Configures filters to include and exclude specific metrics for DSE Metrics Collector. Use a regular expression (regex) to specify which metrics to include and exclude.

By default, the following metrics are always excluded:

Thread Per Core (TPC) metrics at each core level
Keyspace level metrics
DataStax Enterprise (DSE) internal table metrics (except system_auth, paxos, and batchlog metrics)

Use nodetool or Java Console (JConsole) to get a list of node and cluster statistics and metrics.

Synopsis

dsetool insights_filters
--show_filters | --remove_all_filters |
--add --global|--insights_only --allow REGEX | --deny REGEX
--remove --global | --insights_only --allow REGEX | --deny REGEX

Syntax legend
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: `'<<datatype1>,<datatype2>>'` In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and `solrconfig` files, such as `@<xml_entity>='<xml_entity_type>'`.
`[ ]`	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 `'<<schema> ... </schema>>'`
`{ }`	Map collection. Curly braces enclose maps (`{ <key_datatype>:<value_datatype> }`) or key value pairs (`{ <key>:<value> }`). A colon separates the key and the value.
`;`	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_filters

Prints the current filters for DSE Metrics Collector.

--remove_all_filters

Remove all metrics filters for DSE Metrics Collector.

--add

Create a filter that includes metrics matching a given --allow or --deny regular expression, and apply the filter with scope of --global or --insights_only. For example:

--add --global --allow REGEX
--add --insights_only --allow REGEX
--add --global --deny REGEX
--add --insights_only --deny REGEX

--remove

Remove a filter by specifying the --allow or --deny clause and the filter scope (--global or --insights_only). For example:

--remove --global --allow REGEX
--remove --insights_only --allow REGEX
--remove --global --deny REGEX
--remove --insights_only --deny REGEX

Use --show_filters to get the current filters that can be removed.

--global or --insights_only

Used with --add and --remove to set the filter scope:

--global: Set the metrics filter scope to include metrics reported locally and insights data files.
--insights_only: Set the metrics filter scope to insights data files only. Appropriate for diagnostic use.

--allow or --deny

Used with --add and --remove to specify the metrics to match or not match based on a regular expression:

--allow: Include metrics that match the given regex.
--deny: Exclude metrics that match the given regex.

Use a regular expression (regex) to specify which metrics to include or exclude from the filter. The regex is not anchored, so a substring match like Keyspace blocks anything with "keyspace" in the metric name. You can also specify a full regex such as org.apache.cassandra.metrics.Keyspace.+ to filter metrics from a specific keyspace. For details, see Examples.

The following tables describe allowlist and denylist combinations to grant or deny access to a metric using a regex. When evaluating a regex, the denylist always overrides the allowlist.

Allowlist and denylist combinations to grant access
Regex	Denylist	Allowlist	Access
No metric indicated.	-	-	Granted
Metric included in allowlist without any denylist entries	-	Match	Granted
Metric not included in denylist without any allowlist entries	No match	-	Granted
Metric included in allowlist without any matches in denylist	No match	Match	Granted

Allowlist and denylist combinations to deny access
Regex	Denylist	Allowlist	Access
Metric not included in allowlist without any denylist entries	-	No match	Denied
Metric included in denylist without any allowlist entries	Match	-	Denied
Metric not included in allowlist	No match	No match	Denied
Metric included in denylist without a match in the allowlist	Match	No match	Denied
Metric included in both denylist and allowlist	Match	Match	Denied

Examples

Show all active filters

dsetool insights_filters --show_filters

Remove all active filters

dsetool insights_filters --remove_all_filters

Add a global filter to exclude all metrics for a specific keyspace

In this example, the keyspace is named cycling and the table is named ranking:

dsetool insights_filters --add --global --deny "org\\.apache\\.cassandra\\.metrics\\.(cycling|ranking).*(cycling).*"

Remove a previously set filter

Running this command removes the previously set --global --deny filter that excluded all metrics for a specific keyspace. After running this command, those metrics will be recorded again unless they are excluded by another filter. In this example, the keyspace is named cycling and the table is named ranking.

dsetool insights_filters --remove --global --deny "org\\.apache\\.cassandra\\.metrics\\.(cycling|ranking).*(cycling).*"

Add a global filter to deny all metrics matching KeyspaceMetrics

dsetool insights_filters --add --global --deny .+KeyspaceMetrics.+

Add a filter to exclude metrics matching gc from insights data files only

dsetool insights_filters --add --insights_only --deny .+gc.+

dsetool insights_filters

Synopsis

Options

Regex syntax

Examples

See also

Was this helpful?

Give Feedback