Skip to content

feat: Add docs for async logs #1549

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.

Sign up for GitHub

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

Open
as51340 wants to merge 1 commit into
base: memgraph-3-9
Choose a base branch
from
Open

feat: Add docs for async logs #1549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions pages/database-management/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,7 @@ This section contains the list of all other relevant flags used within Memgraph.
| `--isolation-level=SNAPSHOT_ISOLATION` | Isolation level used for the transactions. Allowed values: SNAPSHOT_ISOLATION, READ_COMMITTED, READ_UNCOMMITTED. | `[string]` |
| `--log-file=/var/log/memgraph/memgraph.log` | Path to where the log should be stored. If set to an empty string (`--log-file=`), no logs will be saved. | `[string]` |
| `--log-level=WARNING` | Minimum log level. Allowed values: TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL. | `[string]` |
| `--logger-type=sync` | Type of logger used by Memgraph. Allowed values: `sync`, `async`. When set to `async`, log messages are buffered and written in a background thread, reducing the performance impact of logging on query execution. | `[string]` |
| `--memory-limit=0` | Total memory limit in MiB. Set to 0 to use the default values which are 100% of the physical memory if the swap is enabled and 90% of the physical memory otherwise. | `[uint64]` |
| `--metrics-address` | Host for HTTP server for exposing metrics. | `[string]` |
| `--metrics-port` | Port for HTTP server for exposing metrics. | `[uint64]` |
Expand Down
6 changes: 6 additions & 0 deletions pages/database-management/logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ configuration flag or [during
runtime](/database-management/configuration#change-configuration-settings-during-runtime) using the `SET
DATABASE SETTING "log.level" TO "TRACE";`

By default, Memgraph uses synchronous logging. To reduce the performance impact
of logging on query execution, you can enable asynchronous logging by setting the
[`--logger-type`](/database-management/configuration#other) configuration flag
to `async`. With asynchronous logging, log messages are buffered and written in a
background thread instead of blocking the executing thread.

The configuration set during runtime will be applied only for that session.

You can check the log level by running `SHOW DATABASE SETTING "log.level";` query.
Expand Down