Skip to content

Commit ec0e77c

Browse files
pablocabrera85Copilotafgambin
authored
docs(web-modeler): update Web Modeler logging docs (#7351)
Co-authored-by: Copilot <[email protected]> Co-authored-by: Angel Fernandez <[email protected]>
1 parent 78213b9 commit ec0e77c

File tree

9 files changed

+369
-22
lines changed

9 files changed

+369
-22
lines changed

‎docs/reference/announcements-release-notes/890/890-announcements.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,63 @@ To learn more, see the [8.9.0-alpha1 release notes](/reference/announcements-rel
103103

104104
</div>
105105
</div>
106+
107+
<div className="release-announcement-row">
108+
<div className="release-announcement-badge">
109+
<span className="badge badge--breaking-change">Breaking change</span>
110+
</div>
111+
<div className="release-announcement-content">
112+
113+
#### Web Modeler: Logging framework changed from Logback to Apache Log4j 2
114+
115+
Web Modeler now uses [Apache Log4j 2](https://logging.apache.org/log4j/2.x/) for logging, in alignment with what the Orchestration Cluster uses.
116+
117+
This enhancement ensures consistency across environments and simplifies setup for administrators.
118+
119+
:::info
120+
To learn more, see the [8.9.0-alpha2 release notes](/reference/announcements-release-notes/890/890-release-notes.md#web-modeler-logging-framework-changes-from-logback-to-log4j2).
121+
:::
122+
123+
</div>
124+
</div>
125+
126+
<div className="release-announcement-row">
127+
<div className="release-announcement-badge">
128+
<span className="badge badge--breaking-change">Breaking change</span>
129+
</div>
130+
<div className="release-announcement-content">
131+
132+
#### Web Modeler: Default logging format changed
133+
134+
By default, Web Modeler's `restapi` component now logs in a simple, readable format to the console instead of `JSON`.
135+
136+
This change aligns with the current Orchestration Cluster logging default as defined in its [logging configuration](/self-managed/components/orchestration-cluster/core-settings/configuration/logging.md#pattern-layout-format).
137+
138+
:::info
139+
To learn more, see the [8.9.0-alpha2 release notes](/reference/announcements-release-notes/890/890-release-notes.md#web-modeler-logging-framework-changes-from-logback-to-log4j2).
140+
:::
141+
142+
</div>
143+
</div>
144+
145+
<div className="release-announcement-row">
146+
<div className="release-announcement-badge">
147+
<span className="badge badge--breaking-change">Breaking change</span>
148+
</div>
149+
<div className="release-announcement-content">
150+
151+
#### Web Modeler: JSON format changes
152+
153+
When using JSON as the output for the logs the structure has slightly changed:
154+
155+
- `logger`: This field is now renamed to `loggerName`.
156+
- `thread`: Previously represented the name of the thread. Now we have an object named `threadContext` with a field `name` that has this value.
157+
158+
See [Logging documentation](/self-managed/components/modeler/web-modeler/configuration/logging.md#json-structure) for more information.
159+
160+
:::info
161+
To learn more, see the [8.9.0-alpha2 release notes](/reference/announcements-release-notes/890/890-release-notes.md#web-modeler-logging-framework-changes-from-logback-to-log4j2).
162+
:::
163+
164+
</div>
165+
</div>

‎docs/reference/announcements-release-notes/890/890-release-notes.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,24 @@ These release notes identify the main new features included in the 8.9 minor rel
3333

3434
</details>
3535

36+
## 8.9.0-alpha2
37+
38+
| Release date | Changelog(s) | Blog |
39+
| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- |
40+
| 09 December 2025 | <ul><li>[ Camunda 8 core ](https://github.com/camunda/camunda/releases/tag/8.9.0-alpha2)</li><li>[ Connectors ](https://github.com/camunda/connectors/releases/tag/8.9.0-alpha2)</li></ul> | - |
41+
42+
### Web Modeler: Logging framework changes from Logback to Log4j2
43+
44+
<div class="release"><span class="badge badge--long" title="This feature affects Self-Managed">Self-Managed</span><span class="badge badge--long" title="This feature affects SaaS">SaaS</span><span class="badge badge--medium" title="This feature affects Web Modeler">Web Modeler</span></div>
45+
46+
<!-- https://github.com/camunda/product-hub/issues/3191 -->
47+
48+
Web Modeler now uses [Apache Log4j 2](https://logging.apache.org/log4j/2.x/) for logging. By aligning Web Modeler logging with the Orchestration Cluster, administrators are enabled to more easily configure and maintain Self-Managed deployments.
49+
3650
## 8.9.0-alpha1
3751

38-
| Release date | Changelog(s) | Blog |
39-
| :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- |
52+
| Release date | Changelog(s) | Blog |
53+
| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- |
4054
| 13 November 2025 | <ul><li>[ Camunda 8 core ](https://github.com/camunda/camunda/releases/tag/8.9.0-alpha1)</li><li>[ Connectors ](https://github.com/camunda/connectors/releases/tag/8.9.0-alpha1)</li></ul> | - |
4155

4256
### JDBC driver management for RDBMS integrations

‎docs/reference/announcements-release-notes/890/whats-new-in-89.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
id: whats-new-in-89
3+
title: What's new in Camunda 8.9
4+
sidebar_label: What's new in Camunda 8.9
5+
description: "Learn more about what's new and changed in Camunda 8.9."
6+
keywords:
7+
[
8+
"what's changed",
9+
"what's new",
10+
"whats changed in 8.9",
11+
"what's changed in 8.9",
12+
"8.9 changes",
13+
]
14+
page_rank: 90
15+
---
16+
17+
import OrchestrationClusterImg from '../../img/orchestration-cluster.png';
18+
19+
Important changes in Camunda 8.9 you should consider when upgrading from Camunda 8.8.
20+
21+
## Summary of important changes
22+
23+
Important changes introduced in Camunda 8.9 are summarized as follows:
24+
25+
<table className="table-callout">
26+
<tr>
27+
<td width="30%">**What's new/changed**</td>
28+
<td>**Summary**</td>
29+
</tr>
30+
<tr>
31+
<td>[Web Modeler](#web-modeler)</td>
32+
<td>Migrated logging framework from `Logback` to `Log4j2`. </td>
33+
</tr>
34+
</table>
35+
36+
:::info
37+
38+
- See [release announcements](/reference/announcements-release-notes/890/890-announcements.md) and [release notes](/reference/announcements-release-notes/890/890-release-notes.md) for more detail on what's included in Camunda 8.9.
39+
- Ready to upgrade? See the [upgrade guides](#upgrade-guides) to learn more about upgrading from Camunda 8.8 to 8.9.
40+
41+
:::
42+
43+
## Web Modeler
44+
45+
Web Modeler's `restapi` component uses [Apache Log4j 2](https://logging.apache.org/log4j/2.x/) for logging instead of [Logback](https://logback.qos.ch/).
46+
47+
You can now also change the log levels at runtime.
48+
49+
### Are you affected by 8.9 Web Modeler changes?
50+
51+
The 8.9 changes to Web Modeler `restapi` component could affect your organization if you are in a Self-Managed environment and:
52+
53+
- You are using a custom Logback configuration.
54+
- You are using any tools consuming the logs.
55+
56+
## Upgrade guides {#upgrade-guides}
57+
58+
Camunda 8.9 lays the foundation for future releases. Upgrading ensures compatibility and provides access to enhanced features.
59+
60+
The following guides offer detailed information on how you can upgrade to Camunda 8.9.
61+
62+
<table className="table-callout">
63+
<tr>
64+
<td width="25%">**Guide**</td>
65+
<td>**Description**</td>
66+
<td>**Who is this guide for?**</td>
67+
</tr>
68+
<tr>
69+
<td>[Self-Managed upgrade guide](/self-managed/update/administrators/overview.md)</td>
70+
<td>Evaluate your infrastructure, understand operational changes, and choose the best update strategy for your environment.</td>
71+
<td>Operations and platform administrators of Self-Managed installations.</td>
72+
</tr>
73+
<tr>
74+
<td>[APIs & tools upgrade guide](/apis-tools/migration-manuals/index.md)</td>
75+
<td>Plan and execute an upgrade from Camunda 8.8 to 8.9, focusing on API and tools transitions.</td>
76+
<td><p><ul><li>Application developers maintaining Camunda-based solutions in Self-Managed Kubernetes or VM environments.</li><li>Developers using Camunda APIs and tools.</li></ul></p></td>
77+
</tr>
78+
</table>

‎docs/self-managed/components/components-upgrade/880-to-890.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
id: 880-to-890
3+
sidebar_label: Update 8.8 to 8.9
4+
title: Components update 8.8 to 8.9
5+
description: "Review which adjustments must be made to update from Camunda 8.8.x to Camunda 8.9.0."
6+
---
7+
8+
import Tabs from "@theme/Tabs";
9+
import TabItem from "@theme/TabItem";
10+
11+
The following sections explain which adjustments must be made to migrate from Camunda 8.8.x to 8.9.x.
12+
13+
## Web Modeler
14+
15+
### Cluster configuration
16+
17+
#### Logging framework changed
18+
19+
Web Modeler's `restapi` component now uses [Apache Log4j 2](https://logging.apache.org/log4j/2.x/) for logging.
20+
21+
See [this migration guide](https://logging.apache.org/log4j/2.x/migrate-from-logback.html) to learn about the changes you may need to make if you are using a custom Logback configuration.
22+
23+
### Logging configuration
24+
25+
The default logging configuration is included inline for quick reference.
26+
27+
The default layout displays **time only**, thread name, MDC context, log level, logger name, and message.
28+
29+
#### Example pattern
30+
31+
```perl
32+
%d{HH:mm:ss.SSS} [%t] %notEmpty{[%X] }%-5level %logger{36} - %msg%n
33+
```
34+
35+
See [Logging](/self-managed/components/modeler/web-modeler/configuration/logging.md) for advanced settings and more details.

‎docs/self-managed/components/components-upgrade/introduction.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,18 @@ See the dedicated update guides below for detailed version update instructions.
2525
Depending on your amount of data, run a minor version for at least 24 hours before updating to the next version.
2626
:::
2727

28+
## [Camunda 8.8 to Camunda 8.9](../880-to-890)
29+
30+
Update from 8.8.x to 8.9.x
31+
32+
[Release notes](/reference/announcements-release-notes/890/890-release-notes.md)
33+
34+
## [Camunda 8.7 to Camunda 8.8](../870-to-880)
35+
36+
Update from 8.7.x to 8.8.x
37+
38+
[Release notes](/reference/announcements-release-notes/880/880-release-notes.md)
39+
2840
## [Camunda 8.6 to Camunda 8.7](../860-to-870)
2941

3042
Update from 8.6.x to 8.7.x

‎docs/self-managed/components/modeler/web-modeler/configuration/configuration.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,12 @@ For more details, [see the Zeebe connection troubleshooting section](/self-manag
147147

148148
### Logging
149149

150-
| Environment variable | Description | Example value |
151-
| -------------------- | --------------------------------------------------- | ---------------------------------------------- |
152-
| `LOGGING_CONFIG` | [optional]<br/>Path to custom logback configuration | `file:/full/path/to/custom-logback-config.xml` |
150+
| Environment variable | Description | Example value | Default value |
151+
| ----------------------------------- | -------------------------------------------------------------------- | --------------------------------------------- | ------------- |
152+
| `LOGGING_CONFIG` | [optional]<br/>Path to custom Log4j2 configuration. | `file:/full/path/to/custom-log4j2-spring.xml` | - |
153+
| `CAMUNDA_MODELER_LOG_LEVEL` | [optional]<br/>Defines the log level for the Web Modeler components. | `DEBUG` | `INFO` |
154+
| `CAMUNDA_LOG_FILE_APPENDER_ENABLED` | [optional]<br/>To enable logging to a file. | `true` | `false` |
155+
| `CAMUNDA_MODELER_LOG_APPENDER` | [optional]<br/>Defines which appender to use for logging. | `Stackdriver` | `Console` |
153156

154157
Refer to the [advanced logging configuration guide](./logging.md#logging-configuration-for-the-restapi-component) for additional details on how to customize the `restapi` logging output.
155158

0 commit comments

Comments
 (0)