Skip to content

Commit 48684a4

Browse files
committed
Documented new logging options
1 parent e4740ce commit 48684a4

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

docs/Manual/Programs/Starter/Options.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,17 +273,35 @@ This indicates whether or not a DB server instance should be started
273273
path to rr executable to use if non-empty (default ""). Expert and
274274
debugging only.
275275

276+
- `--log.color=bool`
277+
278+
If set to `true`, console log output is colorized.
279+
The default is `true` when a terminal is attached to stdin,
280+
`false` otherwise or when running on Windows.
281+
282+
- `--log.console=bool`
283+
284+
If set to `true`, log output is written to the console (default `true`).
285+
286+
- `--log.file=bool`
287+
288+
If set to `true`, log output is written to the file (default `true`).
289+
The log file, called `arangodb.log`, can be found in the directory
290+
specified using `--log.dir` or if that is not set, the directory
291+
specified using `--starter.data-dir`.
292+
276293
- `--log.verbose=bool`
277294

278-
show more information (default false).
295+
show more information (default `false`).
279296

280297
- `--log.dir=path`
281298

282299
set a custom directory to which all log files will be written to.
283300
When using the Starter in docker, make sure that this directory is
284301
mounted as a volume for the Starter.
285302

286-
Note: When using a custom log directory, all files will be named as `arangod-<role>-<port>.log`.
303+
Note: When using a custom log directory, all database server files will be named as `arangod-<role>-<port>.log`.
304+
The log for the starter itself is still called `arangodb.log`.
287305

288306
- `--log.rotate-files-to-keep=int`
289307

0 commit comments

Comments
 (0)