Skip to content

Commit aca0f91

Browse files
committed
Improve folder structure
1 parent cc70872 commit aca0f91

File tree

10 files changed

+13
-12
lines changed

10 files changed

+13
-12
lines changed

modules/ROOT/partials/release-notes/release-23.1.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ These options are described in more detail xref:contributor:adr/ADR023-product-i
3737
Component activity within the platform is logged in a way that makes it difficult to find, persist and consolidate this information.
3838
Log configuration is also a challenge.
3939
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).
40-
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].
40+
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].
4141

4242
In this release this has been added to the following components:
4343

modules/ROOT/partials/release-notes/release-23.4.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ See this xref:contributor:adr/ADR026-affinities.adoc[ADR] for more information.
5454

5555
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).
5656
This has now been rolled out across all products.
57-
See this xref:contributor:adr/adr025-logging_architecture[ADR] and this xref:concepts:logging.adoc[concepts page] for more information.
57+
See this xref:contributor:adr/adr025-logging_architecture[ADR] and this xref:concepts:observability/logging.adoc[concepts page] for more information.
5858

5959
===== Service Type
6060

modules/ROOT/partials/release-notes/release-25.3.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Released on 2025-03-21.
3434

3535
===== Observability
3636

37-
Products now log information about their xref:concepts:containerdebug.adoc[container environment], on startup and on an interval after that.
37+
Products now log information about their xref:concepts:observability/containerdebug.adoc[container environment], on startup and on an interval after that.
3838

3939
===== NiFi
4040

modules/concepts/nav.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
*** xref:operations/graceful_shutdown.adoc[]
2323
*** xref:operations/temporary_credentials_lifetime.adoc[]
2424
** Observability
25-
*** xref:labels.adoc[Labels]
26-
*** xref:logging.adoc[Logging]
27-
*** xref:containerdebug.adoc[Container environment]
25+
*** xref:observability/labels.adoc[Labels]
26+
*** xref:observability/logging.adoc[Logging]
27+
*** xref:observability/containerdebug.adoc[Container environment]
2828
*** xref:observability/telemetry.adoc[Telemetry]
2929
** xref:container-images.adoc[]

modules/concepts/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ It covers xref:operations/cluster_operations.adoc[starting, stopping and restart
3434

3535
== Observability
3636

37-
Learn about which xref:labels.adoc[labels] are attached to the operators and the stacklets and the resources that get created by the operator.
38-
Also learn about xref:logging.adoc[].
37+
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.
38+
Also learn about xref:observability/logging.adoc[].

modules/concepts/pages/containerdebug.adoc renamed to modules/concepts/pages/observability/containerdebug.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ main product container.
1717
== Output
1818

1919
The collected information is logged to the Kubernetes pod logs (readable via `kubectl logs <pod>`)
20-
and to the xref:logging.adoc#architecture[shared Stackable log dir]
20+
and to the xref:observability/logging.adoc#architecture[shared Stackable log dir]
2121
(for pickup by the Vector log agent).
2222

2323
Additionally, it is written as JSON to `/stackable/log/containerdebug-state.json`.

modules/concepts/pages/logging.adoc renamed to modules/concepts/pages/observability/logging.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Logging
2+
:page-aliases: logging.adoc
23
:description: A conceptual explanation of the logging architecture of the Stackable Data Platform, and how it is configured.
34
:keywords: logging, observability, log aggregation, Kubernetes, k8s, Vector, Elasticsearch, OpenSearch
45
:vector: https://vector.dev/

modules/contributor/pages/guidelines/logging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
= Implementing log aggregation
66

7-
For a conceptual overview of logging aggregation, consult the xref:concepts:logging.adoc[logging concept page].
7+
For a conceptual overview of logging aggregation, consult the xref:concepts:observability/logging.adoc[logging concept page].
88

99
== Overview
1010

modules/tutorials/pages/logging-vector-aggregator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ and apply it:
6767
[source,bash]
6868
include::example$logging-aggregator/main.sh[tag=zk]
6969

70-
TIP: You can learn more about how to configure logging in a product at the xref:concepts:logging.adoc[logging concept documentation].
70+
TIP: You can learn more about how to configure logging in a product at the xref:concepts:observability/logging.adoc[logging concept documentation].
7171

7272
== Watch the logs
7373

@@ -112,4 +112,4 @@ Congratulations, this concludes the tutorial!
112112

113113
== What's next?
114114

115-
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].
115+
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].

0 commit comments

Comments
 (0)