docs: Add pipeline health condition docs (#969)

Co-authored-by: Małgorzata Świeca <[email protected]>
kyma-project · Apr 15, 2024 · 8618339 · 8618339
1 parent 5e6de22
commit 8618339
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/docs/user/02-logs.md b/docs/user/02-logs.md
@@ -357,7 +357,7 @@ The `tail` input plugin reads the log message from a log file managed by the con
   "time": "2022-05-23T15:04:52.193317532Z",
   "stream": "stdout",
   "_p": "F",
-  "log": "{\"level\": \"warn\",\"message\": \"This is the actual message\",\"tenant\": \"myTenant\",\"traceID\": \"123\"}
+  "log": "{\"level\": \"warn\",\"message\": \"This is the actual message\",\"tenant\": \"myTenant\",\"traceID\": \"123\"}"
 }
 ```
 

diff --git a/docs/user/resources/02-logpipeline.md b/docs/user/resources/02-logpipeline.md
@@ -211,5 +211,12 @@ The status of the LogPipeline is determined by the condition types `AgentHealthy
 | ConfigurationGenerated | False            | ExpiredTLSCert          | TLS certificate expired on YYYY-MM-DD                                                                                                                                                                                               |
 | ConfigurationGenerated | True             | TLSCertAboutToExpire    | TLS certificate is about to expire, configured certificate is valid until YYYY-MM-DD                                                                                                                                                |
 
-
-
+Reflecting the LogPipeline's data flow in `TelemetryFlowHealthy` condition type is currently under development and determined by the following reasons:
+
+| Condition Type       | Condition Status | Condition Reason | Condition Message                                              |
+|----------------------|------------------|------------------|----------------------------------------------------------------|
+| TelemetryFlowHealthy | True             | FlowHealthy      | Logs are flowing normally to backend                           |
+| TelemetryFlowHealthy | False            | BufferFillingUp  | Buffer nearing capacity: incoming log rate exceeds the export rate |
+| TelemetryFlowHealthy | False            | NoLogsDelivered  | No logs delivered to backend                                   |
+| TelemetryFlowHealthy | False            | SomeDataDropped  | Some logs dropped: backend unreachable or rejecting            |
+| TelemetryFlowHealthy | False            | AllDataDropped   | All logs dropped: backend unreachable or rejecting             |
diff --git a/docs/user/resources/04-tracepipeline.md b/docs/user/resources/04-tracepipeline.md
@@ -154,3 +154,13 @@ The status of the TracePipeline is determined by the condition types `GatewayHea
 | ConfigurationGenerated | True             | ConfigurationGenerated  |                                            |
 | ConfigurationGenerated | False            | ReferencedSecretMissing | One or more referenced Secrets are missing |
 | ConfigurationGenerated | False            | MaxPipelinesExceeded    | Maximum pipeline count limit exceeded      |
+
+Reflecting the TracePipeline's data flow in `TelemetryFlowHealthy` condition type is currently under development and determined by the following reasons:
+
+| Condition Type       | Condition Status | Condition Reason  | Condition Message                                                                   |
+|----------------------|------------------|-------------------|-------------------------------------------------------------------------------------|
+| TelemetryFlowHealthy | True             | FlowHealthy       | Traces are flowing normally to backend                                              |
+| TelemetryFlowHealthy | False            | GatewayThrottling | Trace collector experiencing high influx: Unable to receive metrics at the current rate |
+| TelemetryFlowHealthy | False            | BufferFillingUp   | Buffer nearing capacity: incoming trace rate exceeds the export rate                    |
+| TelemetryFlowHealthy | False            | SomeDataDropped   | Some traces dropped: backend unreachable or rejecting                               |
+| TelemetryFlowHealthy | False            | AllDataDropped    | All traces dropped: backend unreachable or rejecting                                |
diff --git a/docs/user/resources/05-metricpipeline.md b/docs/user/resources/05-metricpipeline.md
@@ -181,3 +181,13 @@ The status of the MetricPipeline is determined by the condition types `GatewayHe
 | ConfigurationGenerated | True             | ConfigurationGenerated  |                                            |
 | ConfigurationGenerated | False            | ReferencedSecretMissing | One or more referenced Secrets are missing |
 | ConfigurationGenerated | False            | MaxPipelinesExceeded    | Maximum pipeline count limit exceeded      |
+
+Reflecting the MetricPipeline's data flow in `TelemetryFlowHealthy` condition type is currently under development and determined by the following reasons:
+
+| Condition Type       | Condition Status | Condition Reason  | Condition Message                                                                  |
+|----------------------|------------------|-------------------|------------------------------------------------------------------------------------|
+| TelemetryFlowHealthy | True             | FlowHealthy       | Metrics are flowing normally to backend                                            |
+| TelemetryFlowHealthy | False            | GatewayThrottling | Metric gateway experiencing high influx: Unable to receive metrics at the current rate |
+| TelemetryFlowHealthy | False            | BufferFillingUp   | Buffer nearing capacity: incoming trace rate exceeds the export rate                   |
+| TelemetryFlowHealthy | False            | SomeDataDropped   | Some metrics dropped: backend unreachable or rejecting                             |
+| TelemetryFlowHealthy | False            | AllDataDropped    | All metrics dropped: backend unreachable or rejecting                              |