Skip to content

Commit 27019bc

Browse files
Improve logging docs (#814)
* Add more hints about the Vector Aggregator setup * Elaborate on the custom log config * fix typo * Apply suggestions from code review Co-authored-by: Siegfried Weber <mail@siegfriedweber.net> --------- Co-authored-by: Siegfried Weber <mail@siegfriedweber.net>
1 parent e5d9742 commit 27019bc

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

modules/concepts/pages/observability/logging.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,23 @@ Following the Stackable xref:stacklet.adoc#roles[roles] and xref::stacklet.adoc#
123123
=== Configuring the Aggregator
124124

125125
Follow the {vector-agg-install}[installation instructions{external-link-icon}^] for the aggregator.
126-
Configure a {vector-source-vector}[Vector source{external-link-icon}^] at adress `0.0.0.0:6000` and configure sinks and additional settings according to your needs.
126+
Configure a {vector-source-vector}[Vector source{external-link-icon}^] at address `0.0.0.0:6000` and configure sinks and additional settings according to your needs.
127127

128128
=== Configuring the aggregator location
129129

130130
Every product also has a `vectorAggregatorConfigMapName` property in its spec that needs to be set to the name of the ConfigMap that contains the address of the aggregator.
131131
The field is called `ADDRESS` and the value could be `vector-aggregator:6000` if you're running the aggregator behind a service named `vector-aggregator`.
132132

133+
[source,yaml]
134+
----
135+
apiVersion: v1
136+
kind: ConfigMap
137+
metadata:
138+
name: vector-aggregator-discovery
139+
data:
140+
ADDRESS: vector-aggregator.vector.svc.cluster.local:6000
141+
----
142+
133143
== Custom overrides
134144

135145
As with many parts of the Stackable platform, custom overrides are supported as well, by supplying your own logging configuration file.
@@ -145,7 +155,8 @@ logging:
145155
configMap: my-configmap // <2>
146156
----
147157
<1> The vector logging agent is not deployed.
148-
<2> A custom logging configuration is loaded from a ConfigMap called `my-configmap`.
158+
<2> A custom product logging configuration is loaded from a ConfigMap called `my-configmap`.
159+
The key must be the filename that the product is configured to load, such as `logback.xml`.
149160

150161
== Further reading
151162

0 commit comments

Comments
 (0)