GridGain Developers Hub

Tracing

The Tracing screen displays information about traces recorded during cluster operation. You need to enable tracing. The recorded information can include informational messages, error messages, duration of specific operations, stack traces, etc. You can use this information to troubleshoot cluster operation or identify latency issues.

The screen displays a table containing all recorded traces, including the name of the event, its start time, duration and number of spans.

Tracing Configuration

A trace is recorded information about the execution of a specific event. Each trace consists of a tree of spans. A span is an individual unit of work performed by the system in order to process the event.

A trace can include spans from multiple nodes.

Configuring Tracing

To configure tracing: . Click the CONFIGURE TRACING button in the upper right corner of the page.

+ The Configure Tracing dialog appears.

+ image::images/configure_tracing.png[Configure Tracing]

+ . Choose one or several Included Scopes from the drop-down list for each scope.

+ NOTE: To prevent your cluster from entering the "limited" state due to overload of tracing messages in the corresponding queue, enable only those scopes you really need.

+ . For each of the selected scopes, specify a percentage in the Sampling Rate field.

+ NOTE: Sampling rate controls the percentage of the traces the system stores and analyzes. On 100%, all traces are collected, which might overload the system resources. In most scenarios, you only need to collect a small percentage of the traces to get the general picture. Try a value of 5-10% and observe the results. Balance the usefulness of tracing vs the system performance.

+ . Click OK for the changes to take effect.

Viewing Spans

A span contains a set of tags and a set of logs attached to it. A tag is a key-value pair with information about the span. A log is a key-value pair with information about a specific moment or event within a span.

You can click on a trace name to view the spans included in the trace.

You can also click on a span to view the tags and logs attached to the span.