Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions 3.10/http/administration-and-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Logs
{% docublock get_admin_log %}
{% docublock get_admin_loglevel %}
{% docublock put_admin_loglevel %}
{% docublock get_admin_log_structured %}
{% docublock put_admin_log_structured %}

Statistics
----------
Expand Down
24 changes: 24 additions & 0 deletions 3.10/programs-arangod-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -414,3 +414,27 @@ and fatal messages will be kept.
This option is useful because the number of in-memory log messages is limited
to the latest 2048 messages, and these slots are by default shared between
informational, warning and error messages.

## Structured logging

<small>Introduced in: v3.10.0</small>

structured parameters for logging: `--log.structured-param`

Some log messages can be displayed together with some other useful parameters in a
structured form.
The parameters that can be displayed with the log messages are the name of the
database, username and the url.
The parameters can be set upon starting the server or during execution via HTTP
request. When the parameters are given upon starting the server with
`--log.structured-param`, both providing only the parameter name and providing
it with the `true` value are considered as setting the parameter to true.
Hence, the parameter will be displayed along with the log messages.
The usage upon starting the server is, for example:
`arangod --log.structured-param database=true --log.structured-param username`.
If the parameter is set during execution with via HTTP request, it must be sent
as an object. A parameter that was set upon server start can be unset by
providing its name as a key and `false` as value.
The usage is as in the example:
`arango.PUT("/_admin/log/structured", {"database": true, "url": false})`