Skip to content
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.

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

Web Modeler: added section about activating default logging #4191

Merged
merged 3 commits into from
Sep 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
Loading