# Debug health synchronization ## Overview The [StackState CLI](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/README.md) 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](#list-streams). 2. If you are using sub streams, [verify that the substream exists](#list-sub-streams). The response will also show the number of check states on the substream. This lets you know if the data is being ingested and processed. 3. Investigate further: * **Stream present** - [Check the stream status](#show-stream-status), this will show the metrics latency of the stream and any [errors](#error-messages). * **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](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/configure/health/send-health-data.md). * **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: {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts topic describe --name sts_health_sync ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh $ stac topic show sts_health_sync ``` {% endtab %} {% endtabs %} ## 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 hasn't been created. Follow the [general troubleshooting steps](#general-troubleshooting-steps) to confirm that the stream / substream has been created and that data is arriving in StackState. * The health check state was created, but its `topologyElementIdentifier` doesn't match any `identifiers` from the StackState topology. Use the CLI command [show substream status](#show-substream-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](#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. {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health list STREAM URN | STREAM CONSISTENCY MODEL | SUB STREAM COUNT urn:health:sourceId:streamId | REPEAT_SNAPSHOTS | 1 ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # List streams $ stac health list-streams stream urn substream count -------------------------------------------------- ------------------ urn:health:sourceId:streamId 1 ``` {% endtab %} {% endtabs %} ### List sub streams Returns a list of all sub streams for a given stream URN, together with the number of check states in each. {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health list -u urn:health:sourceId:streamId SUB STREAM ID | CHECK STATE COUNT subStreamId1 | 1 subStreamId2 | 1 ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # List sub streams $ stac health list-sub-streams urn:health:sourceId:streamId substream id check state count ------------------------------ ------------------- subStreamId1 20 subStreamId2 17 ``` {% endtab %} {% endtabs %} ### 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 includes a section `Errors for non-existing sub streams:` as some errors are only relevant when a substream couldn't be created, for example `StreamMissingSubStream`. Substream errors can be any of the documented [error messages](#error-messages). {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health status -u urn:health:sourceId:streamId ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # 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 ---------------------------------------------------------------------------------------------- ------------------------ Substream `substream with ID `subStreamId2`` not started when receiving snapshot stop 6 ``` {% endtab %} {% endtabs %} ### Show substream status The substream status provides useful information to verify that StackState could bind check states sent from an external system to existing topology elements. This information is helpful to debug why a specific check isn't visible on the expected topology element. {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health status -u urn:health:sourceId:streamId -sub-stream-urn subStreamId3 ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # Show a substream 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) - ``` {% endtab %} {% endtabs %} {% hint style="info" %} A substream 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 {% endhint %} The substream 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 aren't 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`. {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health status -u urn:health:sourceId:streamId -sub-stream-urn subStreamId3 -t ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # Show a substream 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 # substream 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 ---------------- ----------------------------- ------------------------------------- ``` {% endtab %} {% endtabs %} ### Delete a health stream The `delete` stream functionality is helpful while setting up a health synchronization in StackState. You can use it 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 don't want to keep using it. {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health delete -u urn:health:sourceId:streamId ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # Delete a health synchronization stream $ stac health delete urn:health:sourceId:streamId ``` {% endtab %} {% endtabs %} ### 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 isn't known to StackState. The only way to suppress such an error would be to use the `clear-errors` command. {% tabs %} {% tab title="CLI: sts" %} {% hint style="info" %} From StackState v5.0, the old `sts` CLI has been renamed to `stac` and there is a new `sts` CLI. The command(s) provided here are for use with the new `sts` CLI. ➡️ [Check which version of the `sts` CLI you are running](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) {% endhint %} ```sh $ sts health clear-error -u urn:health:sourceId:streamId ``` {% endtab %} {% tab title="CLI: stac (deprecated)" %} {% hint style="warning" %} **From StackState v5.0, the old `sts` CLI is called `stac`. The old CLI is now deprecated.** The new `sts` CLI replaces the `stac` CLI. It's 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?](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md#which-version-of-the-cli-am-i-running) * [Install the new `sts` CLI and upgrade the old `sts` CLI to `stac`](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-sts.md#install-the-new-sts-cli) * [Comparison between the CLIs](https://github.com/StackVista/stackstate-docs/blob/k8s-troubleshooting/setup/cli/cli-comparison.md) {% endhint %} ```sh # Clear health stream errors $ stac health clear-errors urn:health:sourceId:streamId ``` {% endtab %} {% endtabs %} ## Error messages {% hint style="info" %} 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. {% endhint %} | 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 doesn't 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 substream for longer than the configured `expiry_interval_s`. In this case, the substream will be deleted. | | **SubStreamLateData** | Raised when the health synchronization doesn't 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 substream previously observed a checkpoint, but the received message is missing the `previous_checkpoint` | | **SubStreamInvalidCheckpoint** | Raised when a Transactional increments substream previously observed a checkpoint, but the received message has a `previous_checkpoint` that isn't equivalent to the last observed one. | | **SubStreamOutdatedCheckpoint** | Raised when a Transactional increments substream 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` isn't present on the substream. | ## See also * [Install the StackState CLI](https://archivedocs.stackstate.com/cli/k8sts-cli-sts)