dsetool perf
Where is the dse.yaml
file?
The location of the dse.yaml
file depends on the type of installation:
Installation Type | Location |
---|---|
Package installations + Installer-Services installations |
|
Tarball installations + Installer-No Services installations |
|
Temporarily changes the running parameters for the CQL Performance Service. Histogram tables provide DSE statistics that can be queried with CQL.
Changes made with performance object subcommands do not persist between restarts and are useful only for short-term diagnostics.
To make these changes permanent, change the CQL Performance Service options in |
Synopsis
dsetool perf subcommand values
Syntax conventions
Syntax conventions | Description |
---|---|
UPPERCASE |
Literal keyword. |
Lowercase |
Not literal. |
|
Variable value. Replace with a valid option or user-defined value. |
|
Optional.
Square brackets ( |
|
Group.
Parentheses ( |
|
Or.
A vertical bar ( |
|
Repeatable.
An ellipsis ( |
|
Single quotation ( |
|
Map collection.
Braces ( |
|
Set, list, map, or tuple.
Angle brackets ( |
|
End CQL statement.
A semicolon ( |
|
Separate the command line options from the command arguments with two hyphens ( |
|
Search CQL only: Single quotation marks ( |
|
Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files. |
clustersummary enable
|disable
-
Whether to enable the collection of database-level statistics for the cluster.
cqlslowlog enable
|disable
-
Whether to enable the collection of CQL queries that exceed the specified time threshold.
cqlslowlog [threshold]
-
This command sets the CQL slow log threshold, allowing for the specification of an exact threshold as a discrete value in milliseconds or as a percentile of the actual request times.
Configuration options include:
-
Values in the range [0,1] are interpreted as a percentile threshold.
-
Values greater than 1 are treated as an absolute, discrete threshold in milliseconds.
-
A value of 1.0 implies no queries are logged.
-
Percentile values are expressed in decimal form:
-
0.999 logs 0.1% of the slowest queries.
-
0.95 logs 5% of the slowest queries.
-
0.5 logs 50% of the slowest queries.
-
-
A value of 0.0 logs all queries.
-
cqlslowlog skip_writing_to_db
-
Keeps slow queries in-memory only.
cqlslowlog write_to_db
-
Writes data to the database. When data writes to the database, the threshold must be >= 2000 ms to prevent a high load on database. Temporary equivalent of
cql_slow_log_options.skip_writing_to_db
: false setting indse.yaml
. cqlslowlog set_num_slowest_queries
-
The number of slow queries to keep in-memory.
cqlslowlog recent_slowest_queries
-
The specified number of the most recent slow queries to retrieve.
cqlsysteminfo enable
|disable
-
Whether to collect CQL system performance information statistics.
dbsummary enable
|disable
-
Whether to collect database summary statistics.
histograms enable
|disable
-
Whether to collect table histograms that measure the distribution of values in a stream of data. Histogram tables provide DSE statistics that can be queried with CQL. The data in the diagnostic histogram tables is cumulative since the DSE server was started.
resourcelatencytracking enable
|disable
-
Whether to collect resource latency tracking statistics.
solrcachestats enable
|disable
-
Whether to collect Solr cache statistics.
solrindexingerrorlog enable
|disable
-
Whether to log Solr indexing errors.
solrindexstats enable
|disable
-
Whether to collect Solr indexing statistics.
solrlatencysnapshots enable
|disable
-
Whether to collect Solr latency snapshots.
solrrequesthandlerstats enable
|disable
-
Whether to collect Solr request handler statistics.
solrslowlog threshold enable
|disable
-
Whether to log the Solr slow sub-query log and set the Solr slow log threshold in milliseconds.
solrupdatehandlerstats enable
|disable
-
Whether to collect Solr update handler statistics.
userlatencytracking enable
|disable
-
Whether to enable user latency tracking.
Examples
These example commands make temporarily changes only. Changes made with performance object subcommands do not persist between restarts and are useful only for short-term diagnostics.
To enable the collection of database-level statistics data:
dsetool perf clustersummary enable
To disable the collection of database-level statistics data:
dsetool perf clustersummary disable
To keep slow queries in-memory only:
dsetool perf cqlslowlog skip_writing_to_db
To set the number of slow queries to keep in-memory:
dsetool perf cqlslowlog set_num_slowest_queries 5
To write slow queries to the database:
dsetool perf cqlslowlog write_to_db
To disable collecting information on slow queries:
dsetool perf cqlslowlog disable
To change the threshold to collect information on 5% of the slowest queries:
dsetool perf cqlslowlog 95.0
To enable collecting information to identify slow search queries:
dsetool perf solrslowlog enable
To change the threshold value (in milliseconds) at which a sub-query is slow enough to be reported:
dsetool perf solrslowlog 200