Skip to content

docs: Mark the Vector agent as an implementation detail #968

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
lfrancke merged 1 commit into from
Oct 27, 2026
Merged

docs: Mark the Vector agent as an implementation detail #968

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions modules/concepts/pages/observability/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ The ConfigMap is then mounted into the containers.
The ZooKeeper Pod has three containers: The `prepare` sidecar container, the `zookeeper` container and the `vector` {vector-sidecar}[sidecar container{external-link-icon}^].
All logs get written into a shared mounted directory, from which the Vector agent reads them and sends them to the Vector {vector-aggregator}[aggregator{external-link-icon}^].

NOTE: The Vector agent is an implementation detail of the operators.
It is not meant to be used outside the Pods the operators create, and its version, configuration and feature set can change with any SDP release.

=== Aggregator and sinks

The aggregator is configured to use one or multiple {vector-sinks}[sinks{external-link-icon}^] (for example OpenSearch, Elasticsearch), it sends all logs to all sinks.
Expand Down Expand Up @@ -125,6 +128,10 @@ Following the Stackable xref:stacklet.adoc#roles[roles] and xref::stacklet.adoc#
Follow the {vector-agg-install}[installation instructions{external-link-icon}^] for the aggregator.
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.

IMPORTANT: Run the aggregator from the upstream Vector image, not from the Vector image published by Stackable.
The Stackable image is for internal use by the operators and is not a stable interface, so its contents can change with any SDP release.
It does not contain most sinks, and an aggregator configured with one of them fails to start.

=== 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.
Expand Down
Loading