Skip to content

Commit 5d31ea2

Browse files
committed
Update doc
1 parent e7aa6b5 commit 5d31ea2

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

docs/design/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@
1414
- [Topology awareness](./topology_awareness.md)
1515
- [Configuring timezone](./configuring_tz.md)
1616
- [Operator API](./api.md)
17+
- [Logging](./logging.md)
18+

docs/design/logging.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Logging configuration
2+
3+
## Operator logging
4+
5+
### Log level
6+
7+
To adjust logging level of the operator, you can use `operator.args` in chart template value
8+
as described in [Additional configuration](./additional_configuration.md).
9+
10+
For example, to set log level to `INFO` and `DEBUG` for `requests` package, you can use the following value:
11+
```yaml
12+
operator:
13+
args: ["--log.level=INFO", "--log.level=requests=DEBUG"]
14+
```
15+
16+
### Log format
17+
18+
By default, operator logs in `pretty` format.
19+
20+
To switch logging format to the JSON, you can use `operator.args` in chart template value:
21+
```yaml
22+
operator:
23+
args: ["--log.prettifyLog=false"]
24+
```
25+
26+
## ArangoDeployment logging
27+
28+
By default, ArangoDeployment logs in `pretty` format.
29+
30+
To switch logging format to the JSON we need to pass `--log.use-json-format` argument to the ArangoDB server in the deployment:
31+
```yaml
32+
apiVersion: database.arangodb.com/v1
33+
kind: ArangoDeployment
34+
metadata:
35+
name: single
36+
spec:
37+
mode: Single
38+
single:
39+
args:
40+
- --log.use-json-format
41+
- --log.level=INFO
42+
- --log.level=backup=TRACE
43+
```

0 commit comments

Comments
 (0)