From aca0f917b7e5f3de0bdc7705b981af483ac754a2 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 7 May 2025 10:43:58 +0200 Subject: [PATCH 1/5] Improve folder structure --- modules/ROOT/partials/release-notes/release-23.1.adoc | 2 +- modules/ROOT/partials/release-notes/release-23.4.adoc | 2 +- modules/ROOT/partials/release-notes/release-25.3.adoc | 2 +- modules/concepts/nav.adoc | 6 +++--- modules/concepts/pages/index.adoc | 4 ++-- .../concepts/pages/{ => observability}/containerdebug.adoc | 2 +- modules/concepts/pages/{ => observability}/labels.adoc | 0 modules/concepts/pages/{ => observability}/logging.adoc | 1 + modules/contributor/pages/guidelines/logging.adoc | 2 +- modules/tutorials/pages/logging-vector-aggregator.adoc | 4 ++-- 10 files changed, 13 insertions(+), 12 deletions(-) rename modules/concepts/pages/{ => observability}/containerdebug.adoc (91%) rename modules/concepts/pages/{ => observability}/labels.adoc (100%) rename modules/concepts/pages/{ => observability}/logging.adoc (99%) diff --git a/modules/ROOT/partials/release-notes/release-23.1.adoc b/modules/ROOT/partials/release-notes/release-23.1.adoc index 10cc9a96b..602ae537a 100644 --- a/modules/ROOT/partials/release-notes/release-23.1.adoc +++ b/modules/ROOT/partials/release-notes/release-23.1.adoc @@ -37,7 +37,7 @@ These options are described in more detail xref:contributor:adr/ADR023-product-i Component activity within the platform is logged in a way that makes it difficult to find, persist and consolidate this information. Log configuration is also a challenge. To address these two issues a logging framework has been added to the platform, offering a consistent custom resource configuration and a separate, persisted sink (the current implementation support OpenSearch). -This is discussed in more detail xref:contributor:adr/ADR025-logging_architecture.adoc[in this ADR] and xref:concepts:logging.adoc[on this concepts page]. +This is discussed in more detail xref:contributor:adr/ADR025-logging_architecture.adoc[in this ADR] and xref:concepts:observability/logging.adoc[on this concepts page]. In this release this has been added to the following components: diff --git a/modules/ROOT/partials/release-notes/release-23.4.adoc b/modules/ROOT/partials/release-notes/release-23.4.adoc index 9f70d0a74..68c1004b6 100644 --- a/modules/ROOT/partials/release-notes/release-23.4.adoc +++ b/modules/ROOT/partials/release-notes/release-23.4.adoc @@ -54,7 +54,7 @@ See this xref:contributor:adr/ADR026-affinities.adoc[ADR] for more information. The logging framework (added to the platform in Release 23.1) offers a consistent custom resource configuration and a separate, persisted sink (defaulting to OpenSearch). This has now been rolled out across all products. -See this xref:contributor:adr/adr025-logging_architecture[ADR] and this xref:concepts:logging.adoc[concepts page] for more information. +See this xref:contributor:adr/adr025-logging_architecture[ADR] and this xref:concepts:observability/logging.adoc[concepts page] for more information. ===== Service Type diff --git a/modules/ROOT/partials/release-notes/release-25.3.adoc b/modules/ROOT/partials/release-notes/release-25.3.adoc index de584c6c8..a1dab9b2a 100644 --- a/modules/ROOT/partials/release-notes/release-25.3.adoc +++ b/modules/ROOT/partials/release-notes/release-25.3.adoc @@ -34,7 +34,7 @@ Released on 2025-03-21. ===== Observability -Products now log information about their xref:concepts:containerdebug.adoc[container environment], on startup and on an interval after that. +Products now log information about their xref:concepts:observability/containerdebug.adoc[container environment], on startup and on an interval after that. ===== NiFi diff --git a/modules/concepts/nav.adoc b/modules/concepts/nav.adoc index 458e753a3..c81bfa18c 100644 --- a/modules/concepts/nav.adoc +++ b/modules/concepts/nav.adoc @@ -22,8 +22,8 @@ *** xref:operations/graceful_shutdown.adoc[] *** xref:operations/temporary_credentials_lifetime.adoc[] ** Observability -*** xref:labels.adoc[Labels] -*** xref:logging.adoc[Logging] -*** xref:containerdebug.adoc[Container environment] +*** xref:observability/labels.adoc[Labels] +*** xref:observability/logging.adoc[Logging] +*** xref:observability/containerdebug.adoc[Container environment] *** xref:observability/telemetry.adoc[Telemetry] ** xref:container-images.adoc[] diff --git a/modules/concepts/pages/index.adoc b/modules/concepts/pages/index.adoc index ad3da9a8c..7a42a8c38 100644 --- a/modules/concepts/pages/index.adoc +++ b/modules/concepts/pages/index.adoc @@ -34,5 +34,5 @@ It covers xref:operations/cluster_operations.adoc[starting, stopping and restart == Observability -Learn about which xref:labels.adoc[labels] are attached to the operators and the stacklets and the resources that get created by the operator. -Also learn about xref:logging.adoc[]. +Learn about which xref:observability/labels.adoc[labels] are attached to the operators and the stacklets and the resources that get created by the operator. +Also learn about xref:observability/logging.adoc[]. diff --git a/modules/concepts/pages/containerdebug.adoc b/modules/concepts/pages/observability/containerdebug.adoc similarity index 91% rename from modules/concepts/pages/containerdebug.adoc rename to modules/concepts/pages/observability/containerdebug.adoc index 29a1f31a5..f6ee03708 100644 --- a/modules/concepts/pages/containerdebug.adoc +++ b/modules/concepts/pages/observability/containerdebug.adoc @@ -17,7 +17,7 @@ main product container. == Output The collected information is logged to the Kubernetes pod logs (readable via `kubectl logs `) -and to the xref:logging.adoc#architecture[shared Stackable log dir] +and to the xref:observability/logging.adoc#architecture[shared Stackable log dir] (for pickup by the Vector log agent). Additionally, it is written as JSON to `/stackable/log/containerdebug-state.json`. diff --git a/modules/concepts/pages/labels.adoc b/modules/concepts/pages/observability/labels.adoc similarity index 100% rename from modules/concepts/pages/labels.adoc rename to modules/concepts/pages/observability/labels.adoc diff --git a/modules/concepts/pages/logging.adoc b/modules/concepts/pages/observability/logging.adoc similarity index 99% rename from modules/concepts/pages/logging.adoc rename to modules/concepts/pages/observability/logging.adoc index 7bbe0fc00..dc3b5249e 100644 --- a/modules/concepts/pages/logging.adoc +++ b/modules/concepts/pages/observability/logging.adoc @@ -1,4 +1,5 @@ = Logging +:page-aliases: logging.adoc :description: A conceptual explanation of the logging architecture of the Stackable Data Platform, and how it is configured. :keywords: logging, observability, log aggregation, Kubernetes, k8s, Vector, Elasticsearch, OpenSearch :vector: https://vector.dev/ diff --git a/modules/contributor/pages/guidelines/logging.adoc b/modules/contributor/pages/guidelines/logging.adoc index ebf73d53a..be2eacb24 100644 --- a/modules/contributor/pages/guidelines/logging.adoc +++ b/modules/contributor/pages/guidelines/logging.adoc @@ -4,7 +4,7 @@ = Implementing log aggregation -For a conceptual overview of logging aggregation, consult the xref:concepts:logging.adoc[logging concept page]. +For a conceptual overview of logging aggregation, consult the xref:concepts:observability/logging.adoc[logging concept page]. == Overview diff --git a/modules/tutorials/pages/logging-vector-aggregator.adoc b/modules/tutorials/pages/logging-vector-aggregator.adoc index 0256413e7..0e436f6df 100644 --- a/modules/tutorials/pages/logging-vector-aggregator.adoc +++ b/modules/tutorials/pages/logging-vector-aggregator.adoc @@ -67,7 +67,7 @@ and apply it: [source,bash] include::example$logging-aggregator/main.sh[tag=zk] -TIP: You can learn more about how to configure logging in a product at the xref:concepts:logging.adoc[logging concept documentation]. +TIP: You can learn more about how to configure logging in a product at the xref:concepts:observability/logging.adoc[logging concept documentation]. == Watch the logs @@ -112,4 +112,4 @@ Congratulations, this concludes the tutorial! == What's next? -Look into different sink configurations which are more suited to production use in the https://vector.dev/docs/reference/configuration/sinks/[sinks overview documetation] or learn more about how logging works on the platform in the xref:concepts:logging.adoc[concepts documentation]. \ No newline at end of file +Look into different sink configurations which are more suited to production use in the https://vector.dev/docs/reference/configuration/sinks/[sinks overview documetation] or learn more about how logging works on the platform in the xref:concepts:observability/logging.adoc[concepts documentation]. From 99a96730eedcf920a399591ea9fdf19ca7ca8d51 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 7 May 2025 10:49:43 +0200 Subject: [PATCH 2/5] Add note on telemetry --- modules/concepts/pages/observability/telemetry.adoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/modules/concepts/pages/observability/telemetry.adoc b/modules/concepts/pages/observability/telemetry.adoc index 58ec67fa1..ca2284214 100644 --- a/modules/concepts/pages/observability/telemetry.adoc +++ b/modules/concepts/pages/observability/telemetry.adoc @@ -1,4 +1,10 @@ -= Telemetry signals in operators += Operational telemetry signals in operators + +[NOTE] +==== +Telemetry data is useful for your own observability and monitoring systems. +There is no "call-home" functionality, data is not exported out of the container unless explicitly configured. +==== Since SDP 25.7.0, all Stackable operators emit telemetry data in the following ways: From 1ee511a28ad4e66ccb38d2be1495b5b53920c9b6 Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 7 May 2025 11:02:48 +0200 Subject: [PATCH 3/5] linter --- modules/contributor/pages/guidelines/logging.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/contributor/pages/guidelines/logging.adoc b/modules/contributor/pages/guidelines/logging.adoc index be2eacb24..67fc3d9eb 100644 --- a/modules/contributor/pages/guidelines/logging.adoc +++ b/modules/contributor/pages/guidelines/logging.adoc @@ -188,4 +188,4 @@ if let Some(ContainerLogConfig { log_config, )); } ----- \ No newline at end of file +---- From 741ba3c3e3e3f01c6eba3271f327fcd1522233be Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 7 May 2025 13:25:34 +0200 Subject: [PATCH 4/5] Update modules/concepts/pages/observability/telemetry.adoc Co-authored-by: Techassi --- modules/concepts/pages/observability/telemetry.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/concepts/pages/observability/telemetry.adoc b/modules/concepts/pages/observability/telemetry.adoc index ca2284214..9a7bcf773 100644 --- a/modules/concepts/pages/observability/telemetry.adoc +++ b/modules/concepts/pages/observability/telemetry.adoc @@ -3,7 +3,8 @@ [NOTE] ==== Telemetry data is useful for your own observability and monitoring systems. -There is no "call-home" functionality, data is not exported out of the container unless explicitly configured. +There is no "call-home" functionality. +Data is not exported out of the container unless explicitly configured. ==== Since SDP 25.7.0, all Stackable operators emit telemetry data in the following ways: From c408df234d20b8dbd8466c32e5dc1d399b8df38f Mon Sep 17 00:00:00 2001 From: Sebastian Bernauer Date: Wed, 7 May 2025 13:26:53 +0200 Subject: [PATCH 5/5] Update modules/concepts/pages/observability/telemetry.adoc --- modules/concepts/pages/observability/telemetry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/concepts/pages/observability/telemetry.adoc b/modules/concepts/pages/observability/telemetry.adoc index 9a7bcf773..3acba8bc4 100644 --- a/modules/concepts/pages/observability/telemetry.adoc +++ b/modules/concepts/pages/observability/telemetry.adoc @@ -1,4 +1,4 @@ -= Operational telemetry signals in operators += Telemetry signals in operators [NOTE] ====