nodesync tracing show

Displays the events of a NodeSync tracing session.

Synopsis

nodesync main_options tracing show
[(-c | --color)]
[(-f | --follow)]
[(-i <traceIdStr> | --id <traceIdStr>)]
[(-n <nodeList> | --nodes <nodeList>)]
[--quiet]
[(-t <timeoutStr> | --timeout <timeoutStr>)]
[(-v | --verbose)]
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: <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.

Common options

The following options are available to all nodesync commands:

-ca, --cql-auth-provider cql_Authprovider

CQL auth provider class name.

-cp, --cql-password cql_password

CQL password.

-cs | --cql-ssl

Use SSL for CQL connection.

-cu, --cql-username cql_username

CQL username.

-h, --host cql_host

Connect to the specified remote CQL host.

help

Displays options and usage instructions. Use nodesync help subcommand for more information on a specific command.

-jp, --jmx-password jmx_password

JMX password.

-jpf, --jmx-password-file jmx_password_file

Path to JMX password file.

-js | --jmx-ssl

Use SSL for JMX.

-ju, --jmx-username jmx_username

JMX username.

-p, --port cql_port

Connection port for CQL.

-k, --keyspace keyspace_name

Specify a default keyspace for unqualified table names or wildcards in the table_list.

The keyspace must be an alterable keyspace: system_distributed keyspace or a user-created keyspace. An error results when attempting to run these commands on an unalterable keyspace such as system_auth.

For example, when the keyspace is alterable:

nodesync disable -v -k system_distributed "*"

Nodesync disabled for system_distributed.nodesync_status
Nodesync disabled for system_distributed.backups
...
Nodesync disabled for system_distributed.repair_history
--
+
As compared to an unalterable keyspace:
+
[source,console]
--
nodesync disable -v -k system_auth "*"

Error: Keyspace [system_auth] is not alterable.
--
+
You can use a CQL command to enable or disable nodesync for unalterable keyspaces, such as a `system_*` keyspace.
For example:
+
[source,console]
--
ALTER TABLE system_auth.roles WITH nodesync = {'enabled': 'false'};
--quiet

Suppress warning and error messages.

-v, --verbose

Enable verbose console output

--

Separates table list from the rest of the command.

table_list

Target tables using any of the following methods:

  • Qualified table names: keyspace_name.table_name. For example, cycling.comments.

  • Default keyspace -k option with:

    • Unqualified table names. For example -k cycling cyclist_alt_stats comments cyclist_races.

    • An asterisk in double quotes to select all tables. For example, -k cycling "*".

-n, --nodes node_list

Only disable tracing on the listed nodes. Specify the host name or IP address in a comma separated list.

Default: All nodes

--quiet

Suppresses messages from displaying on stdout.

Show options

-c, --color

If --follow is used, color each trace event according from which host it originates from

-f, --follow

After enabling tracing, continuously show the trace events, showing new events as they occur. Will not exit unless manually terminated using Ctrl-c or in conjunction with the --timeout option.

-l <levelStr>, --level <levelStr>

The tracing level: either 'low' or 'high'. If omitted, the 'low' level is used. Note that the 'high' level is somewhat verbose and should be used with care.

-i <traceIdStr>, --id <traceIdStr>

Show any nodes using the specified trace ID.

-t <timeoutStr>, --timeout <timeoutStr>

When --follow is used, automatically exit after the provided amount of time elapses. This default to seconds, but a 's', 'm' or 'h' suffix can be used for seconds, minutes or hours respectively.

Examples

nodesync tracing show -i e60dfd70-eb5a-11e7-8bde-b5dcb560a8ef
Starting NodeSync tracing on /10.200.176.186 (elapsed: 2.7ms)
Adding continuous proposer for demo.health_data (elapsed: 6.9m)
[#-] Skipping (10,-9223372036854775808] of demo.health_data, state updated: was recently validated by another node (2h ago, previously know: 2h ago) (elapsed: 6.9m)
[#0] Starting validation on (-9223372036854775798,10] of demo.health_data (validated 2h ago) (elapsed: 6.9m)
[#1] Starting validation on (-9223372036854775808,-9223372036854775798] of demo.health_data (validated 2.1h ago) (elapsed: 6.9m)
[#0] Completed validation (full_in_sync) in 4ms: validated 0B and repaired 0B (elapsed: 6.9m)
[#2] Starting validation on (10,-9223372036854775808] of demo.health_data (validated 2h ago) (elapsed: 6.9m)
[#1] Completed validation (full_in_sync) in 9ms: validated 0B and repaired 0B (elapsed: 6.9m)
[#2] Completed validation (full_in_sync) in 2ms: validated 0B and repaired 0B (elapsed: 6.9m)

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2025 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM