Skip to content
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

Jump to bottom

docs: example logging configuration for the history server #458

Merged
merged 1 commit into from
Sep 4, 2024
Merged

docs: example logging configuration for the history server #458

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
46 changes: 46 additions & 0 deletions docs/modules/spark-k8s/pages/usage-guide/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,49 @@ The Spark operator installs a https://vector.dev/docs/setup/deployment/roles/#ag
It is the user's responsibility to install and configure the vector aggregator, but the agents can discover the aggregator automatically using a discovery ConfigMap as described in the xref:concepts:logging.adoc[logging concepts].

NOTE: Only logs produced by the application's driver and executors are collected. Logs produced by `spark-submit` are discarded.

== History server

The following snippet shows how to configure log aggregation for the history server:

[source,yaml]
----
apiVersion: spark.stackable.tech/v1alpha1
kind: SparkHistoryServer
metadata:
name: spark-history
spec:
vectorAggregatorConfigMapName: spark-vector-aggregator-discovery # <1>
nodes:
roleGroups:
default:
config:
logging:
enableVectorAgent: true # <2>
containers:
spark-history: #<3>
console:
level: INFO
file:
level: INFO
loggers:
ROOT:
level: INFO
...
----
<1> Name of a ConfigMap that referenced the vector aggregator. See example below.
<2> Enable the vector agent in the history pod.
<3> Configure log levels for file and console outputs.

Example vector aggregator configuration.

[source,yaml]
----
---
apiVersion: v1
kind: ConfigMap
metadata:
name: spark-vector-aggregator-discovery
data:
ADDRESS: spark-vector-aggregator:6123
----
Loading