Skip to content

Improve logging docs #814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NickLarsenNZ merged 4 commits into from
Dec 11, 2025
Merged

Improve logging docs #814

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e36670
Add more hints about the Vector Aggregator setup
NickLarsenNZ Dec 10, 2025
cba7d5f
Elaborate on the custom log config
NickLarsenNZ Dec 10, 2025
6f32176
fix typo
NickLarsenNZ Dec 10, 2025
8d87d7c
Apply suggestions from code review
NickLarsenNZ Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions modules/concepts/pages/observability/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,23 @@ Following the Stackable xref:stacklet.adoc#roles[roles] and xref::stacklet.adoc#
=== Configuring the Aggregator

Follow the {vector-agg-install}[installation instructions{external-link-icon}^] for the aggregator.
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.
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.

=== Configuring the aggregator location

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.
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`.

[source,yaml]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: vector-aggregator-discovery
data:
ADDRESS: vector-aggregator.vector.svc.cluster.local:6000
----

== Custom overrides

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

== Further reading

Expand Down
Loading