Skip to content

Commit

Permalink
change docs for server flag
Browse files Browse the repository at this point in the history
  • Loading branch information
ShohamBit committed Jan 6, 2025
1 parent 7f09d6b commit 9179f50
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 15 deletions.
22 changes: 10 additions & 12 deletions docs/docs/install/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,22 @@ A complete config file with all available options can be found [here](https://gi
### Server
- **`--metrics-endpoint`**: Enables the metrics endpoint.

__NOTE__: You can view more in the [Prometheus section](../prometheus.md).
- __`--server`__: Sets options for the HTTP and/or gRPC servers.

YAML:
```yaml
metrics-endpoint: true
```

- **`--grpc-listen-addr`**: Specifies the address for the gRPC server.

YAML:
```yaml
grpc-listen-addr: tcp:50051
server:
http:
address: "127.0.0.1:8080"
metrics: true
healthz: true
pprof: true
pyroscope: true
grpc:
address: "unix:/var/run/tracee.sock"
```


### Process Tree

- **`--proctree` (`-t`)**: Controls process tree options.
Expand Down
11 changes: 9 additions & 2 deletions examples/config/global_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,15 @@ capabilities:

metrics-endpoint: true

grpc-listen-addr: tcp:50051

server:
http:
address: "127.0.0.1:8080"
metrics: true
healthz: true
pprof: true
pyroscope: true
grpc:
address: "unix:/var/run/tracee.sock"
dnscache: enable

cri:
Expand Down
2 changes: 1 addition & 1 deletion tests/e2e-inst-test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ for TEST in $TESTS; do
--signatures-dir "$SIG_DIR" \
--scope comm=echo,mv,ls,tracee,proctreetester,ping,ds_writer,fsnotify_tester,process_execute,tracee-ebpf,writev,set_fs_pwd.sh,sys_src_tester \
--dnscache enable \
--grpc-listen-addr unix:/tmp/tracee.sock \
--server grpc.address=unix:/tmp/tracee.sock \
--events "$TEST""

# Some tests might need event parameters
Expand Down

0 comments on commit 9179f50

Please sign in to comment.