dsetool insights_filters

Configures filters to include and exclude specific metrics for DSE Metrics Collector.

By default, the following metrics are always excluded:

Thread Per Core (TPC) metrics at each core level
Keyspace level metrics
DSE internal table metrics (except system_auth, paxos, and batchlog 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

Options

--show_filters

Prints the current filters for DSE Metrics Collector.

--remove_all_filters

Remove all metrics filters for DSE Metrics Collector.

--add

Include metrics that match 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

Exclude metrics that match a given --allow or --deny regular expression and apply the filter with scope of --global or --insights_only. For example:

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

--global

The metrics filter scope includes metrics reported locally and insights data files.

--insights_only

Limit metrics filter scope to insights data files only. Appropriate for diagnostic use.

--allow

Include metrics that match the given regular expression (regex).

--deny

Exclude metrics that match the given regular expression (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 deny all metrics for a specific keyspace

dsetool insights_filters --add --global --deny "org\\.apache\\.cassandra\\.metrics\\.(KEYSPACE_NAME|TABLE_NAME]).*(KEYSPACE_NAME).*"

Add a global filter to deny all metrics matching KeyspaceMetrics

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

Remove a global filter to allow metrics for a specific keyspace that has an existing deny filter

dsetool insights_filters --remove --global --deny "org\\.apache\\.cassandra\\.metrics\\.(KEYSPACE_NAME|TABLE_NAME]).*(KEYSPACE_NAME).*"

Add a filter to insights data files that deny grace period metrics

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