From cc58199a96f483ff58e733ec31fd3f2d89537d76 Mon Sep 17 00:00:00 2001 From: ShohamBit Date: Mon, 6 Jan 2025 20:07:58 +0000 Subject: [PATCH] change docs for server flag --- docs/docs/install/config/index.md | 22 ++++++++++------------ examples/config/global_config.yaml | 11 +++++++++-- tests/e2e-inst-test.sh | 2 +- 3 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/docs/install/config/index.md b/docs/docs/install/config/index.md index decba88e1be7..669bd3aa1f15 100644 --- a/docs/docs/install/config/index.md +++ b/docs/docs/install/config/index.md @@ -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. diff --git a/examples/config/global_config.yaml b/examples/config/global_config.yaml index 628e6d5ef83f..71b84e6dc2a0 100644 --- a/examples/config/global_config.yaml +++ b/examples/config/global_config.yaml @@ -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: diff --git a/tests/e2e-inst-test.sh b/tests/e2e-inst-test.sh index 39a06395ee02..6fa5946d9025 100755 --- a/tests/e2e-inst-test.sh +++ b/tests/e2e-inst-test.sh @@ -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