Skip to content

Commit 4200cc0

Browse files
authored
Merge pull request #1588 from StackVista/stac-22515
STAC-22515: Drop repeat states documentation
2 parents 4d87780 + e3caa23 commit 4200cc0

5 files changed

Lines changed: 1 addition & 124 deletions

File tree

SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
* [Send health data over HTTP](configure/health/send-health-data/README.md)
6262
* [Send health data](configure/health/send-health-data/send-health-data.md)
6363
* [Repeat Snapshots JSON](configure/health/send-health-data/repeat_snapshots.md)
64-
* [Repeat States JSON](configure/health/send-health-data/repeat_states.md)
6564
* [Transactional Increments JSON](configure/health/send-health-data/transactional_increments.md)
6665
* [Debug health synchronization](configure/health/debug-health-sync.md)
6766

configure/health/debug-health-sync.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ $ sts health status -u urn:health:sourceId:streamId -sub-stream-urn subStreamId3
7878
{% hint style="info" %}
7979
A substream status will show the metadata related to the consistency model:
8080
* **Repeat Snapshots** - Show repeat interval and expiry
81-
* **Repeat States** - Show repeat interval and expiry
8281
* **Transactional Increments** - Show checkpoint offset and checkpoint batch index
8382
{% endhint %}
8483

configure/health/health-synchronization.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The health synchronization framework works as follows:
3434
![Health synchronization pipeline](../../.gitbook/assets/health-sync-pipeline.svg)
3535

3636
### Consistency models
37-
SUSE Observability health synchronization relies on different consistency models to guarantee that the data sent from an external monitoring system matches with what SUSE Observability ingests and shows. The consistency model is specified in the `"health"` property of the [common JSON object](/configure/health/send-health-data/send-health-data.md#common-json-object) or as an argument in the SUSE Observability CLI when health data is sent to SUSE Observability. The supported models are: `REPEAT_SNAPSHOTS`, `REPEAT_STATES` and `TRANSACTIONAL_INCREMENTS`.
37+
SUSE Observability health synchronization relies on different consistency models to guarantee that the data sent from an external monitoring system matches with what SUSE Observability ingests and shows. The consistency model is specified in the `"health"` property of the [common JSON object](/configure/health/send-health-data/send-health-data.md#common-json-object) or as an argument in the SUSE Observability CLI when health data is sent to SUSE Observability. The supported models are: `REPEAT_SNAPSHOTS` and `TRANSACTIONAL_INCREMENTS`.
3838
{% tabs %}
3939
{% tab title="Repeat snapshots model" %}
4040
The `REPEAT_SNAPSHOTS` consistency model works with periodic, full snapshots of all checks in an external monitoring system. SUSE Observability keeps track of the checks in each received snapshot and decides if associated external check states need to be created, updated or deleted in SUSE Observability. For example, if a check state is no longer present in a snapshot. This model offers full control over which external checks will be deleted as all decisions are inferred from the received snapshots. There is no ambiguity over the external checks that will be present in SUSE Observability.
@@ -44,14 +44,6 @@ The `REPEAT_SNAPSHOTS` consistency model works with periodic, full snapshots of
4444
**JSON payload:** The [Repeat Snapshots health payload](/configure/health/send-health-data/repeat_snapshots.md) accepts specific properties to specify when a snapshot starts or stops.
4545
{% endtab %}
4646

47-
{% tab title="Repeat States model" %}
48-
The `REPEAT_STATES` consistency model works with periodic checks received from an external monitoring system. SUSE Observability keeps track of the checks and decides if associated external checks need to be created or updated in SUSE Observability. A configurable expiry mechanism is used to delete external checks that aren't observed anymore. This model offers less control over data than the `REPEAT_SNAPSHOTS` model. As an expiry configuration is used to delete external checks, it might happen that elements are deleted due to barely missing the expiry timeout. This would reflect as external checks disappearing and reappearing in SUSE Observability.
49-
50-
**Use this model when:** The external monitoring system isn't capable of collecting all checks in a determined time window. The best effort is just to send the external checks as they're obtained.
51-
52-
**JSON payload:** The [Repeat States health payload](/configure/health/send-health-data/repeat_states.md) accepts specific properties to specify the expiry configuration.
53-
{% endtab %}
54-
5547
{% tab title="Transactional Increments model" %}
5648
The `TRANSACTIONAL_INCREMENTS` consistency model is designed to be used on streaming systems where only incremental changes are communicated to SUSE Observability. As there is no repetition of data, data consistency is upheld by ensuring that at-least-once delivery is guaranteed across the entire pipeline. To detect whether any data is missing, SUSE Observability requires that both a checkpoint and the previous checkpoint are communicated together with the `check_states`. This model requires strict control across the whole pipeline to guarantee no data loss.
5749

configure/health/send-health-data/repeat_states.md

Lines changed: 0 additions & 112 deletions
This file was deleted.

configure/health/send-health-data/send-health-data.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Topology, telemetry and health data are sent to the receiver API via HTTP POST.
4343
SUSE Observability accepts health data based on a chosen [consistency model](/configure/health/health-synchronization.md#consistency-models). The message that can be sent for each model are described on the pages below:
4444

4545
* [Repeat Snapshots JSON](/configure/health/send-health-data/repeat_snapshots.md)
46-
* [Repeat States JSON](/configure/health/send-health-data/repeat_states.md)
4746
* [Transactional Increments JSON](/configure/health/send-health-data/transactional_increments.md)
4847

4948
## See also

0 commit comments

Comments
 (0)