dsetool insights_filters
Configures filters to include and exclude specific metrics for DSE Metrics Collector.
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)
Use a regular expression (regex) to specify which metrics to include or exclude from the filter. See Filtering 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 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. |
- --show_filters
- Prints the current filters for DSE Metrics Collector.
- --remove_all_filters
- Remove all metrics filters for DSE Metrics Collector.
- --add --global|--insights_only regex
- Include metrics that match this regular expression and apply the filter with scope of --global or --insights_only.
- --deny --global|--insights_only regex
- Exclude metrics that match this regular expression and apply the filter with scope of --global or --insights_only.
- --global
- 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.
Example filters
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.+