Skip to content

Commit

Permalink
docs(engine): add skipIsolationLevelCheck flag and update documenta…
Browse files Browse the repository at this point in the history
  • Loading branch information
joaquinfelici authored Sep 4, 2024
1 parent 5303b47 commit 31eb92a
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
19 changes: 17 additions & 2 deletions content/reference/deployment-descriptors/tags/process-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ The following is a list with the most commonly used process engine configuration
<br><br>
A custom hostname can be generated by providing an implementation of the
{{< javadocref page="org/camunda/bpm/engine/impl/history/event/HostnameProvider.html" text="HostnameProvider" >}}
interface and and setting the engine property `hostnameProvider` to an instance of that class.
interface and and setting the engine property <code>hostnameProvider</code> to an instance of that class.
<br><br>
</td>
</tr>
Expand Down Expand Up @@ -551,6 +551,21 @@ The following is a list with the most commonly used process engine configuration
</p>
</td>
</tr>
<tr>
<td><code>skipIsolationLevelCheck</code></td>
<td>Boolean</td>
<td>
If the value of this flag is set to <code>false</code>, a <code>ProcessEngineException</code> will be thrown if the transaction isolation level set for the database is different from the recommended one.
If set to <code>true</code>, no exception will be thrown but a warning message will be logged.
<p>
The default value is <code>false</code>.
</p>
<p>
<strong>Note</strong>: The <a href="{{<ref "/user-guide/process-engine/database/database-configuration.md#isolation-level-configuration" >}}">recommended transaction isolation level</a> that ensures the correct behaviour of the engine is <code>READ_COMMITTED</code>.
</p>
<strong>Values:</strong> <code>true</code>, <code>false</code> (Boolean).
</td>
</tr>
<tr>
<td><code>jdbcBatchProcessing</code></td>
<td>Boolean</td>
Expand Down Expand Up @@ -1094,7 +1109,7 @@ The following is a list with the most commonly used process engine configuration
<td>String</td>
<td><a href="{{< ref "/user-guide/process-engine/history/history-cleanup.md">}}">History cleanup</a> batch window end time in the format <code>HH:mmZ</code> (Z is for RFC 822 time zone) or <code>HH:mm</code>. E.g., <code>23:00-0300</code> or <code>23:00</code>. In case <code>batchWindowEndTime</code> exceeds <code>batchWindowStartTime</code> it is considered
to be on the same date (e.g., cleanup runs each day between 20:00 and 23:00). Otherwise it is considered to be on the next calendar day (e.g., cleanup starts each
day at 20:00 and finishes the next day at 01:00). Default value is `00:00`.</td>
day at 20:00 and finishes the next day at 01:00). Default value is <code>00:00</code>.</td>
</tr>
<tr>
<td><code>mondayHistoryCleanupBatchWindowStartTime</code></td>
Expand Down
11 changes: 10 additions & 1 deletion content/update/minor/721-to-722/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ This document guides you through the update from Camunda `7.21.x` to `7.22.0` an
1. For developers: [Camunda Connect dependency removed from `camunda-engine`](#camunda-connect-dependency-removed-from-camunda-engine)
1. For administrators and developers: [Update to JBoss EAP 8.0](#update-to-jboss-eap-8)
1. For administrators and developers: [Update to Tomcat 10 Server](#update-to-tomcat-10-server)
1. For Administrators and developers: [Camunda Run and Swagger Update](#camunda-run-and-swagger-update)
1. For administrators and developers: [Camunda Run and Swagger Update](#camunda-run-and-swagger-update)
1. For administrators and developers: [Update to Groovy 4.0](#update-to-groovy-4)
1. For administrators and developers: [Sending telemetry feature removed](#sending-telemetry-feature-removed)
1. For administrators: [Database transaction isolation level `READ_COMMITTED` is enforced](#database-transaction-isolation-level-read-committed-is-enforced)

This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda 7.22.

Expand Down Expand Up @@ -255,3 +256,11 @@ We recommend to remove the usage of the following API as the endpoints no longer
* REST API
* [Fetch Telemetry Configuration](https://docs.camunda.org/rest/camunda-bpm-platform/7.22/#tag/Telemetry/operation/getTelemetryConfiguration) (always returns `false`)
* [Configure Telemetry](https://docs.camunda.org/rest/camunda-bpm-platform/7.22/#tag/Telemetry/operation/configureTelemetry)

# Database transaction isolation level `READ_COMMITTED` is enforced

When starting the engine, a check is performed in order to determine if the transaction isolation level set for the database is different from the recommended one `READ_COMMITTED`. If it is, an exception will be thrown.

This behaviour can be disabled by setting the `skipIsolationLevelCheck` flag to `true`. Doing this will prevent an exception from being thrown and a warning message will be logged instead.

[See here]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) for more details about this and other properties.
Original file line number Diff line number Diff line change
Expand Up @@ -174,3 +174,9 @@ Most database management systems provide four different isolation levels to be s
* SERIALIZABLE

The required isolation level to run Camunda with is **READ COMMITTED**, which may have a different name according to your database system. Setting the level to REPEATABLE READS is known to cause deadlocks, so one needs to be careful, when changing the isolation level.

When initializing the engine, a check is performed in order to determine if the transaction isolation level set for the database is different from the recommended one. If it is, an exception will be thrown.

This behaviour can be disabled by setting the `skipIsolationLevelCheck` flag to `true`. Doing this will prevent an exception from being thrown and a warning message will be logged instead.

[See here]({{< ref "/reference/deployment-descriptors/tags/process-engine.md#configuration-properties" >}}) for more details about this and other properties.

0 comments on commit 31eb92a

Please sign in to comment.