Skip to content

Commit

Permalink
Web Modeler: added section about activating default logging (#4191)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanlukas authored Sep 8, 2024
1 parent b5b0225 commit 1aea7eb
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/self-managed/modeler/web-modeler/configuration/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Web Modeler's `restapi` component uses the [logback framework](https://logback.q
`restapi` component logs to the Docker container's standard output. To change the default logging behavior, create a
custom configuration file and let the `restapi` know of it by specifying the following environment variable:

```
```properties
LOGGING_CONFIG=file:/full/path/to/custom-logback-config.xml
```

Expand All @@ -20,6 +20,12 @@ for more information on how to customize the logback configuration for specific
Enabling `DEBUG` logging for the `restapi` component can be useful for troubleshooting purposes, e.g. for
[debugging Zeebe connection issues](../troubleshooting/troubleshoot-zeebe-connection.md#how-can-i-debug-log-grpc--zeebe-communication).

By default, Web Modeler's `restapi` component logs in JSON. For a more readable logging format, activate the Spring profile using the following:

```properties
SPRING_PROFILES_INCLUDE=default-logging
```

## Logging configuration for the `webapp` component

By default, the `webapp` component logs to the Docker container's standard output.
Expand All @@ -28,7 +34,7 @@ By default, the `webapp` component logs to the Docker container's standard outpu

To enable additional log output to a file, adjust the following environment variable:

```
```properties
LOG_FILE_PATH=/full/path/to/log/file.log
```

Expand All @@ -42,6 +48,6 @@ To enable additional log output to a file, follow these steps:

1. Mount a volume to the directory `/var/www/html/storage/logs`. The logs will be written to a file named `laravel.log` located inside this directory.
2. Adjust the following environment variable:
```
```properties
LOG_CHANNEL=single
```
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ for more information on how to customize the logback configuration for specific
Enabling `DEBUG` logging for the `restapi` component can be useful for troubleshooting purposes, e.g. for
[debugging Zeebe connection issues](../troubleshooting/troubleshoot-zeebe-connection.md#how-can-i-debug-log-grpc--zeebe-communication).

By default, Web Modeler's `restapi` component logs in JSON. For a more readable logging format, activate the Spring profile using the following:

```properties
SPRING_PROFILES_INCLUDE=default-logging
```

## Logging configuration for the `webapp` component

By default, the `webapp` component logs to the Docker container's standard output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ for more information on how to customize the logback configuration for specific
Enabling `DEBUG` logging for the `restapi` component can be useful for troubleshooting purposes, e.g. for
[debugging Zeebe connection issues](../troubleshooting/troubleshoot-zeebe-connection.md#how-can-i-debug-log-grpc--zeebe-communication).

By default, Web Modeler's `restapi` component logs in JSON. For a more readable logging format, activate the Spring profile using the following:

```properties
SPRING_PROFILES_INCLUDE=default-logging
```

## Logging configuration for the `webapp` component

By default, the `webapp` component logs to the Docker container's standard output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ for more information on how to customize the logback configuration for specific
Enabling `DEBUG` logging for the `restapi` component can be useful for troubleshooting purposes, e.g. for
[debugging Zeebe connection issues](../troubleshooting/troubleshoot-zeebe-connection.md#how-can-i-debug-log-grpc--zeebe-communication).

By default, Web Modeler's `restapi` component logs in JSON. For a more readable logging format, activate the Spring profile using the following:

```properties
SPRING_PROFILES_INCLUDE=default-logging
```

## Logging configuration for the `webapp` component

By default, the `webapp` component logs to the Docker container's standard output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ for more information on how to customize the logback configuration for specific
Enabling `DEBUG` logging for the `restapi` component can be useful for troubleshooting purposes, e.g. for
[debugging Zeebe connection issues](../troubleshooting/troubleshoot-zeebe-connection.md#how-can-i-debug-log-grpc--zeebe-communication).

By default, Web Modeler's `restapi` component logs in JSON. For a more readable logging format, activate the Spring profile using the following:

```properties
SPRING_PROFILES_INCLUDE=default-logging
```

## Logging configuration for the `webapp` component

By default, the `webapp` component logs to the Docker container's standard output.
Expand Down

0 comments on commit 1aea7eb

Please sign in to comment.