docs: document default log configuration #5289

npepinpe · 2025-03-18T19:22:37Z

Description

This PR documents the logging configuration used by the C8 orchestration cluster.

I've opted to link to the configuration instead of pasting its contents, since this is more likely to get out of sync. I then focused mostly on the ways the user can re-configure it without providing their own log4j2.xml file.

Note that since 8.6, this applies not just to Zeebe, but to C8 as a whole. However, we have no "general" or "streamlined" configuration section, everything is by components =/

I think it would be good to have this, but it may be a bit out of scope here, and a bigger refactoring/rewrite.

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
This is already available but undocumented and should be released within a week. (add available & undocumented label)
This is on a specific schedule and the assignee will coordinate a release with the DevEx team. (create draft PR and/or add hold label)
This is part of a scheduled alpha or minor. (add alpha or minor label)
There is no urgency with this change (add low prio label)

PR Checklist

My changes are for an upcoming minor release and:
- are in the /docs directory (version 8.8).
- are in the /versioned_docs/version-8.7/ directory (version 8.7).
My changes are for an already released minor and are in a /versioned_docs directory.

I added a DRI, team, or delegate as a reviewer for technical accuracy and grammar/style:
- Engineering team review
- Technical writer review via @camunda/tech-writers unless working with an embedded writer.

ChrisKujawa

Thanks @npepinpe 👍🏼 Great improvement 🚀

I'm not sure regarding the mention of optimize and single app, etc. as it is in the zeebe deployment. But as you mention we have still the separate components and no single place for the complete platform.

@akeller do we plan to consolidate the component docs into one, like for the single application? I think I talked about this with @christinaausley recently as well.

Edit: See for example comment here

ChrisKujawa · 2025-03-18T20:10:31Z

docs/self-managed/zeebe-deployment/configuration/logging.md

-
-</Configuration>
-```
+[You can find the default log4j2.xml used by the application here](https://github.com/camunda/camunda/blob/main/dist/src/main/config/log4j2.xml).


❓ should we change this to a perma link?

ChrisKujawa · 2025-03-19T08:38:28Z

docs/self-managed/zeebe-deployment/configuration/logging.md

+:::note
+[See our documentation on log levels to understand what the various log levels mean.](../../operational-guides/monitoring/log-levels.md)
+:::
+


👍🏼 TIL; I wasnt aware that we document this official

ChrisKujawa · 2025-03-19T08:39:45Z

docs/self-managed/zeebe-deployment/configuration/logging.md

+Additionally, it will configure three possible [appenders](https://logging.apache.org/log4j/2.x/manual/appenders.html) (aka outputs):
+
+- `RollingFile`: [A rolling file appender](https://logging.apache.org/log4j/2.x/manual/appenders/rolling-file.html) which prints out to a file
+  (by default, `logs/zeebe.log` relative from the distribution root). After a day, or once that file reaches 250MB, the file is "rolled" into a


🔧 I would remove this, as this totally depends on the load, log level, connectivity issues, etc.

Suggested change

(by default, `logs/zeebe.log` relative from the distribution root). After a day, or once that file reaches 250MB, the file is "rolled" into a

(by default, `logs/zeebe.log` relative from the distribution root). Once that file reaches 250MB, the file is "rolled" into a

We have the <TimeBasedTriggeringPolicy> configured, so it will also roll it after a day if it hasn't reached 250MB.

The TimeBasedTriggeringPolicy causes a rollover, when the smallest time unit in filePattern changes value. So the rollover can occur at the end of a month, week, at midnight, end of the hour, etc.

Since our smallest unit is the day, then after a day (or so I understand) it will rollover.

Ah ok I missed that sorry

ChrisKujawa · 2025-03-19T08:41:12Z

docs/self-managed/zeebe-deployment/configuration/logging.md

+  [pattern layout](https://logging.apache.org/log4j/2.x/manual/pattern-layout.html), directly to standard out. **This is enabled by default, and is
+  mutually exclusive with the `Stackdriver` appender. You can select one them via `ZEEBE_LOG_APPENDER`, e.g. `ZEEBE_LOG_APPENDER=Console` or
+  `ZEEBE_LOG_APPENDER=Stackdriver`.**


🔧 I would first introduce, explain stackdriver and then talk about the mutually exclusivity, etc.

ChrisKujawa · 2025-03-19T08:42:29Z

versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/logging.md

+
+- `ZEEBE_LOG_LEVEL`: will set the level for anything under `io.camunda.zeebe`, i.e. Zeebe related.
+- `ATOMIX_LOG_LEVEL`: will set the level for anything clustering or raft related.
+- `OPTIMIZE_LOG_LEVEL`: will set the level for anything under `io.camunda.optimize`.


❓ Does it make sense to mention this here? As it is related to zeebe deployment?

Good point. I would assume we will remove it? I actually don't know how much of the shared codebase they will reuse, but we could remove it here considering the overall direction 👍

akeller

Is this the beginning of us deleting all the component-specific logging pages?!?!?!

github-actions · 2025-03-20T18:47:00Z

docs/self-managed/zeebe-deployment/configuration/logging.md

-
-</Configuration>
-```
+You can find the default log4j2.xml used by the application in the [Github repository](https://github.com/camunda/camunda/blob/main/dist/src/main/config/log4j2.xml).


🚫 [vale] _{reported by reviewdog 🐶}
[all.glossary] Inconsistent spelling detected. Use GitHub instead of Github. Review the WCoE glossary - https://confluence.camunda.com/x/b5RZBw .

github-actions · 2025-03-20T18:47:01Z

versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/logging.md

-```
+## Default logging configuration
+
+You can find the default log4j2.xml used by the application in the [Github repository](https://github.com/camunda/camunda/blob/main/dist/src/main/config/log4j2.xml).


🚫 [vale] _{reported by reviewdog 🐶}
[all.glossary] Inconsistent spelling detected. Use GitHub instead of Github. Review the WCoE glossary - https://confluence.camunda.com/x/b5RZBw .

github-actions · 2025-03-20T18:47:01Z

versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/logging.md

-```
+## Default logging configuration
+
+You can find the default log4j2.xml used by the application in the [Github repository](https://github.com/camunda/camunda/blob/main/dist/src/main/config/log4j2.xml).


🚫 [vale] _{reported by reviewdog 🐶}
[all.glossary] Inconsistent spelling detected. Use GitHub instead of Github. Review the WCoE glossary - https://confluence.camunda.com/x/b5RZBw .

conceptualshark

I reworded/reorganized a few things, but it shouldn't have changed any of the technical specifics, and I didn't address any of the open questions still on this PR. I did leave one question regarding content. Otherwise this looks good to me, happy to approve if all else is ready to go. 👍

conceptualshark · 2025-03-20T18:45:59Z

docs/self-managed/zeebe-deployment/configuration/logging.md

 ## Google Stackdriver (JSON) logging

 To enable Google Stackdriver compatible JSON logging, set the environment variable `ZEEBE_LOG_APPENDER=Stackdriver` before starting Zeebe.


With Stackdriver now explained in the next section, I'm wondering if this could be removed?

github-actions · 2025-03-20T19:01:34Z

The preview environment relating to the commit 6e8e478 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-5289/index.html

docs: document default log configuration

b6d044b

npepinpe self-assigned this Mar 18, 2025

npepinpe requested review from ChrisKujawa and a team March 18, 2025 19:22

ChrisKujawa added the deploy Stand up a temporary docs site with this PR label Mar 19, 2025

ChrisKujawa previously approved these changes Mar 19, 2025

View reviewed changes

github-actions bot temporarily deployed to camunda-docs March 19, 2025 08:46 Destroyed

akeller reviewed Mar 19, 2025

View reviewed changes

akeller requested a review from conceptualshark March 19, 2025 20:33

tw review

dce069a

conceptualshark dismissed ChrisKujawa’s stale review via dce069a March 20, 2025 18:45

github-actions bot reviewed Mar 20, 2025

View reviewed changes

Vale fix

383282f

conceptualshark approved these changes Mar 20, 2025

View reviewed changes

github-actions bot temporarily deployed to camunda-docs March 20, 2025 18:57 Destroyed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: document default log configuration #5289

docs: document default log configuration #5289

npepinpe commented Mar 18, 2025

ChrisKujawa left a comment •

edited

Loading

ChrisKujawa Mar 18, 2025

ChrisKujawa Mar 19, 2025

ChrisKujawa Mar 19, 2025

npepinpe Mar 19, 2025

ChrisKujawa Mar 19, 2025

ChrisKujawa Mar 19, 2025

ChrisKujawa Mar 19, 2025

npepinpe Mar 19, 2025

akeller left a comment

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

conceptualshark left a comment

conceptualshark Mar 20, 2025

github-actions bot commented Mar 20, 2025

	(by default, `logs/zeebe.log` relative from the distribution root). After a day, or once that file reaches 250MB, the file is "rolled" into a
	(by default, `logs/zeebe.log` relative from the distribution root). Once that file reaches 250MB, the file is "rolled" into a

		## Google Stackdriver (JSON) logging

		To enable Google Stackdriver compatible JSON logging, set the environment variable `ZEEBE_LOG_APPENDER=Stackdriver` before starting Zeebe.

docs: document default log configuration #5289

Are you sure you want to change the base?

docs: document default log configuration #5289

Conversation

npepinpe commented Mar 18, 2025

Description

When should this change go live?

PR Checklist

ChrisKujawa left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akeller left a comment

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

conceptualshark left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 20, 2025

ChrisKujawa left a comment •

edited

Loading