Skip to content

Commit

Permalink
Move instructions to agent crate README
Browse files Browse the repository at this point in the history
  • Loading branch information
gememma committed Feb 4, 2025
1 parent ea5eae9 commit 77a17d7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
8 changes: 1 addition & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,13 +465,7 @@ To debug it with a debugger:
## Retrieving Agent Logs
You can change the minimum severity of logs emitted by the agent by setting `agent.log_level` in the mirrord config
file, for example:
```json
"agent": {
"log_level": "mirrord=trace"
}
```
To change the minimum severity of logs emitted by the agent, see [the agent crate's README](mirrord/agent/README.md#log-level-in-the-agent).
By default, the agent's pod will complete and disappear shortly after the agent exits. In order to be able to retrieve
the agent's logs after it crashes, set the agent's pod's TTL to a comfortable number of seconds. This configuration can
Expand Down
2 changes: 1 addition & 1 deletion changelog.d/+agent-log-level-instructions.internal.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Add instructions to CONTRIBUTING.md for changing the agent log level in mirrord config.
Add instructions to CONTRIBUTING.md for changing the agent log level in mirrord config/ agent README.
12 changes: 11 additions & 1 deletion mirrord/agent/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# mirrord-agent
[![CI](https://github.com/metalbear-co/mirrord/actions/workflows/ci.yaml/badge.svg)](https://github.com/metalbear-co/mirrord/actions/workflows/ci.yaml)

Agent part of [mirrord](https://github.com/metalbear-co/mirrord) responsible for running on the same node as the debuggee, entering it's namespace and collecting traffic.
Agent part of [mirrord](https://github.com/metalbear-co/mirrord) responsible for running on the same node as the debuggee, entering its namespace and collecting traffic.

mirrord-agent is written in Rust for safety, low memory consumption and performance.

Expand Down Expand Up @@ -201,3 +201,13 @@ spec:
targetPort: 9090
nodePort: 30909
```

## Log level in the agent

You can change the minimum severity of logs emitted by the agent by setting `agent.log_level` in the mirrord config
file, for example by adding:
```json
"agent": {
"log_level": "mirrord=trace"
}
```

0 comments on commit 77a17d7

Please sign in to comment.