Debug health synchronization

StackState Self-hosted v5.0.x

This page describes StackState version 5.0.

Go to the documentation for the latest StackState release.

Overview

The StackState CLI can be used to troubleshoot a health synchronization and fix issues that might prevent health data from being correctly ingested and displayed in StackState. This page describes the general troubleshooting steps to take when debugging a health synchronization, as well as the CLI commands used, and a description of the error messages returned.

General troubleshooting steps

When debugging the health synchronization there are some common verification steps that can be made no matter what the specific issue is:

1. Verify that the stream exists.

2. If you are using sub streams, verify that the sub stream exists. The response will also show the number of check states on the sub stream. This lets you know if the data is being ingested and processed.

3. Investigate further:

   • Stream present - Check the stream status, this will show the metrics latency of the stream and any errors.

   • Streams / sub streams present, but there are no check states - Confirm that the payload sent to the Receiver API adheres to the health payload specification.

   • No streams / sub streams are present - Use the CLI command below to verify that health data sent to the Receiver API is arriving in StackState:

CLI: stac

stac topic show sts_health_sync

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

Common issues

Check state not visible on the component

There can be two reasons for a check state not to show on a component in StackState:

• The health check state has not been created. Follow the general troubleshooting steps to confirm that the stream / sub stream has been created and that data is arriving in StackState.

• The health check state was created, but its topologyElementIdentifier does not match any identifiers from the StackState topology. Use the CLI command show sub stream status to verify if there are any Check states with identifier which has no matching topology element.

Check state slow to update in StackState

The main reason for this is that the latency of the health synchronization is higher than expected. Use the CLI command show stream status to confirm the latency of the stream as well as the throughput of messages and specific check operations. It may be necessary to tweak the data sent to the health synchronization, or the frequency with which data is sent.

Useful CLI commands

List streams

Returns a list of all current synchronized health streams and the number of sub streams included in each.

CLI: stac

# List streams
stac health list-streams

stream urn                                            sub stream count
--------------------------------------------------  ------------------
urn:health:sourceId:streamId                                         1

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

List sub streams

Returns a list of all sub streams for a given stream URN, together with the number of check states in each.

CLI: stac

# List sub streams
stac health list-sub-streams urn:health:sourceId:streamId 

sub stream id                     check state count
------------------------------  -------------------
subStreamId1                                     20
subStreamId2                                     17

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

Show stream status

The stream status command returns the aggregated stream latency and throughput metrics. This is helpful when debugging why a health check takes a long time to land on the expected topology elements. It will help diagnose if the frequency of data sent to StackState should be adjusted. The output contains a section Errors for non-existing sub streams: as some errors are only relevant when a sub stream could not be created, for example StreamMissingSubStream. Sub stream errors can be any of the documented error messages.

CLI: stac

# Show a stream status
stac health show urn:health:sourceId:streamId

Aggregate metrics for the stream and all substreams:

metric                             value between now and 300 seconds ago    value between 300 and 600 seconds ago    value between 600 and 900 seconds ago
---------------------------------  ---------------------------------------  ---------------------------------------  ---------------------------------------
latency (Seconds)                  1.102                                    1.102                                    -
messages processed (per second)    0.256                                    0.16                                     -
check states created (per second)  0.10555555555555556                      0.10666666666666667                      -
check states updated (per second)  -                                        -                                        -
check states deleted (per second)  -                                        -                                        -

Errors for non-existing sub streams:

error message                                                                                   error occurrence count
----------------------------------------------------------------------------------------------  ------------------------
Sub stream `substream with id `subStreamId2`` not started when receiving snapshot stop                          6

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

Show sub stream status

The sub stream status provides useful information to verify that check states sent to StackState from an external system could be bound and linked to existing topology elements. This information is helpful to debug why a specific check is not visible on the expected topology element.

CLI: stac

# Show a sub stream status.
stac health show urn:health:sourceId:streamId -s "subStreamId3"

Synchronized check state count: 32
Repeat interval (Seconds): 120
Expiry (Seconds): 240

Synchronization errors:

code    level    message    occurrence count
------  -------  ---------  ------------------

Synchronization metrics:

metric                             value between now and 300 seconds ago    value between 300 and 600 seconds ago    value between 600 and 900 seconds ago
---------------------------------  ---------------------------------------  ---------------------------------------  ---------------------------------------
latency (Seconds)                  0.23                                     0.125                                    0.265
messages processed (per second)    0.256                                    0.2773333333333333                       0.256
check states created (per second)  -                                        -                                        -
check states updated (per second)  -                                        -                                        -
check states deleted (per second)  -

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

A sub stream status will show the metadata related to the consistency model:

• Repeat Snapshots - Show repeat interval and expiry

• Repeat States - Show repeat interval and expiry

• Transactional Increments - Show checkpoint offset and checkpoint batch index

The sub stream status can be expanded to include details of matched and unmatched check states using the -t command line argument. This is helpful to identify any health states that are not attached to a topology element. In the example below, checkStateId2 is listed under Check states with identifier which has no matching topology element. This means that it was not possible to match the check state to a topology element with the identifier server-2.

CLI: stac

# Show a sub stream status matched/unmatched check states.
stac health show urn:health:sourceId:streamId -s "subStreamId3" -t
# If we configured our stream to not use explicit substreams then a default 
# sub stream can be reached by omitting the optional substreamId parameter as in: 
#stac health show urn:health:sourceId:streamId -t

Check states with identifier matching exactly 1 topology element: 32

Check states with identifier which has no matching topology element:

check state id    topology element identifier
----------------  -----------------------------
checkStateId2     server-2

Check states with identifier which has multiple matching topology elements:

check state id    topology element identifier    number of matched topology elements
----------------  -----------------------------  -------------------------------------

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

Delete a health stream

The delete stream functionality is helpful while setting up a health synchronization in StackState. It allows you to experiment, delete the data and start over again clean. You can also delete a stream and drop its data when you are sure that you do not want to keep using it.

CLI: stac

# Delete a health synchronization stream
stac health delete urn:health:sourceId:streamId

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

Clear health stream errors

The clear-errors option removes all errors from a health stream. This is helpful while setting up a health synchronization in StackState, or, for the case of the TRANSACTIONAL_INCREMENTS consistency model, when some errors can't be removed organically. For example, a request to delete a check state might raise an error if the check state is not known to StackState. The only way to suppress such an error would be to use the clear-errors command.

CLI: stac

# Clear health stream errors
stac health clear-errors urn:health:sourceId:streamId 

⚠️ PLEASE NOTE - from StackState v5.0, the old sts CLI is called stac.

In a future release of StackState, the new sts CLI will fully replace the stac CLI. It is advised to install the new sts CLI and upgrade any installed instance of the old sts CLI to stac. For details see:

• Which version of the sts CLI am I running?

• Install the new sts CLI and upgrade the old sts CLI to stac

• Comparison between the CLIs

CLI: sts (new)

Command not currently available in the new sts CLI. Use the stac CLI.

Error messages

Errors will be closed once the described issue has been remediated.

For example a SubStreamStopWithoutStart will be closed once the health synchronization observes a start snapshot message followed by a stop snapshot message.

Error	Description
StreamMissingSubStream	Raised when the health synchronization receives messages without a previous stream setup message as start_snapshot or expiry.
StreamConsistencyModelMismatch	Raised when a message is received that belongs to a different consistency model than that specified when the stream was created.
StreamMissingSubStream	Raised when the health synchronization receives messages with a previous start snapshot in place.
SubStreamRepeatIntervalTooHigh	Raised when the health synchronization receives a repeat_interval_s greater than the configured max of 30 minutes.
SubStreamStartWithoutStop	Raised when the health synchronization receives a second message to open a snapshot when a previous snapshot was still open.
SubStreamCheckStateOutsideSnapshot	Raised when the health synchronization receives external check states without previously opening a snapshot.
SubStreamStopWithoutStart	Raised when the health synchronization receives a stop snapshot message without having started a snapshot at all.
SubStreamMissingStop	Raised when the health synchronization does not receive a stop snapshot after time out period of two times the repeat_interval_s established in the start snapshot message. In this case an automatic stop snapshot will be applied.
SubStreamExpired	Raised when the health synchronization stops receiving data on a particular sub stream for longer than the configured expiry_interval_s. In this case, the sub stream will be deleted.
SubStreamLateData	Raised when the health synchronization does not receive a complete snapshot timely based on the established repeat_interval_s.
SubStreamTransformerError	Raised when the health synchronization is unable to interpret the payload sent to the receiver. For example, "Missing required field 'name'" with payload {"checkStateId":"checkStateId3","health":"deviating","message":"Unable to provision the device. ","topologyElementIdentifier":"server-3"} and transformation Default Transformation.
SubStreamMissingCheckpoint	Raised when a Transactional increments sub stream previously observed a checkpoint, but the received message is missing the previous_checkpoint
SubStreamInvalidCheckpoint	Raised when a Transactional increments sub stream previously observed a checkpoint, but the received message has a previous_checkpoint that is not equivalent to the last observed one.
SubStreamOutdatedCheckpoint	Raised when a Transactional increments sub stream previously observed a checkpoint, but the received message has a checkpoint that precedes the last observed one, meaning that its data that StackState already received.
SubStreamUnknownCheckState	Raised when deleting a Transactional increments check_state and the check_state_id is not present on the sub stream.

See also

• Install the StackState CLI