Skip to content

Commit 2ef4bfd

Browse files
Remove references to USAGE_LOGGERS_EBPF_ROLE (fixes #5)
1 parent a2499b3 commit 2ef4bfd

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,13 @@ for analysis and storage. This agent logs encrypted API calls without configurin
4545

4646
## Environment Variables
4747

48-
These environment variables are used to configure this eBPF agent and to control what information is logged.
48+
These environment variables are required to configure this eBPF agent and to control what information is logged.
4949

50-
| Variable Name | Default | Description |
51-
|---------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52-
| USAGE_LOGGERS_DISABLE | false | When `true`, the eBPF agent is loaded but no calls are logged |
53-
| USAGE_LOGGERS_EBPF_EXPATH | (none) | Path to OpenSSL shared library<br>Use `ldconfig -p \| grep ssl` to find |
54-
| USAGE_LOGGERS_EBPF_ROLE | (none) | Use `server` for inbound calls, `client` for outbound calls |
55-
| USAGE_LOGGERS_RULES | (none) | [Logging rules](https://go2docs.graylog.org/apisecurity-current/logging_rules/logging_rules.htm) used to mask or remove specific details<br>Use `import debug` to log entire request and response |
56-
| USAGE_LOGGERS_URL | (none) | [Capture URL](https://go2docs.graylog.org/apisecurity-current/capture_api_calls/capture_api_calls.htm) for Graylog API Security instance<br>Looks like `https://GL_APISECURITY_HOST/fluke/message` |
50+
| Variable Name | Description |
51+
|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52+
| USAGE_LOGGERS_EBPF_EXPATH | Path to OpenSSL shared library<br>Use `ldconfig -p \| grep ssl` to find |
53+
| USAGE_LOGGERS_RULES | [Logging rules](https://go2docs.graylog.org/apisecurity-current/logging_rules/logging_rules.htm) used to mask or remove specific details<br>Use `include debug` to log entire request and response |
54+
| USAGE_LOGGERS_URL | [Capture URL](https://go2docs.graylog.org/apisecurity-current/capture_api_calls/capture_api_calls.htm) for Graylog API Security instance<br>Looks like `https://GL_APISECURITY_HOST/fluke/message` |
5755

5856
<a name="logging-from-linux-vm-or-physical-machine"></a>
5957

@@ -66,7 +64,7 @@ wget https://github.com/resurfaceio/logger-ebpf/releases/download/v1.1.0/ebpf-lo
6664

6765
Run agent binary, with your value for `GL_APISECURITY_HOST`:
6866
```bash
69-
sudo USAGE_LOGGERS_EBPF_EXPATH="/lib/x86_64-linux-gnu/libssl.so.3" USAGE_LOGGERS_EBPF_ROLE="server" USAGE_LOGGERS_RULES="include debug" USAGE_LOGGERS_URL="https://GL_APISECURITY_HOST/fluke/message" ./ebpf-logger-amd64
67+
sudo USAGE_LOGGERS_EBPF_EXPATH="/lib/x86_64-linux-gnu/libssl.so.3" USAGE_LOGGERS_RULES="include debug" USAGE_LOGGERS_URL="https://GL_APISECURITY_HOST/fluke/message" ./ebpf-logger-amd64
7068
```
7169

7270
⚠️ Use `CRTL-C` to stop the agent.

0 commit comments

Comments
 (0)