Skip to content

ADR025: Disable log aggregation by default #330

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
siegfriedweber merged 1 commit into from
Dec 20, 2022
Merged

ADR025: Disable log aggregation by default #330

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
40 changes: 24 additions & 16 deletions modules/contributor/pages/adr/ADR025-logging_architecture.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,31 +193,39 @@ Like the other logging settings, this custom configuration file can be supplied

Setting the `custom` field will disable any configurations made in `file` and `console`. (TODO maybe we can disallow this altogether in the CRD type)

**Disable vector** - Vector should be optional, if the user wants to use their own logging system.
**Enable vector** - Vector is optional, so that the users can use their own logging system.

To enable it, the property `enableVectorAgent` must be set to `true`. In this
case, also the `vectorAggregatorConfigMapName` must contain the name of the
Vector aggregator discovery ConfigMap.

```yaml
logging:
enableVectorAgent: false # defaults to true
vectorAggregatorConfigMapName: vector-aggregator-discovery
...
logging:
enableVectorAgent: true # defaults to false
```

**Summary** - To summarize, a complete logging configuration looks like this:

```yaml
logging:
enableVectorAgent: true
containers: # can contain configuration for multiple containers
myContainer:
console:
level: INFO
file:
level: INFO
loggers: # can contain configuration for multiple modules
ROOT:
vectorAggregatorConfigMapName: vector-aggregator-discovery
...
logging:
enableVectorAgent: true
containers: # can contain configuration for multiple containers
myContainer:
console:
level: INFO
my.module:
file:
level: INFO
custom: # this field cannot be used together with the others. Using it will override any settings made in the other fields
configMap: my-configmap
loggers: # can contain configuration for multiple modules
ROOT:
level: INFO
my.module:
level: INFO
custom: # this field cannot be used together with the others. Using it will override any settings made in the other fields
configMap: my-configmap
```

[#deploying_the_stack]
Expand Down