Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
msiodelski committed Feb 14, 2024
1 parent 945c96a commit 8e37a0f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Endure
## Endure ![workflow](https://github.com/msiodelski/endure/actions/workflows/rust.yml/badge.svg)

Endure is a DHCP diagnostics utility installed next to a server or relay. It analyzes the inbound and outbound DHCP traffic and collects various diagnostic metrics.

Expand Down Expand Up @@ -41,9 +41,9 @@ Endure is a new project with limited capabilities. However, it can already colle
|--------|-------------|
|`opcode_boot_requests_percent`|A percentage of `BootRequest` packets|
|`opcode_boot_replies_percent`|A percentage of the `BootReply` packets|
|`opcode_invalid_percent`|A percentage of neither request nor reply packets.|
|`opcode_invalid_percent`|A percentage of neither request nor reply packets|
|`retransmit_percent`|Percent of retransmissions|
|`retransmit_secs_avg`|Average number of seconds the DHCP clients have been retrying to acquire a lease.|
|`retransmit_secs_avg`|Average number of seconds the DHCP clients have been retrying to acquire a lease|
|`retransmit_longest_trying_client`|MAC address of a client who has been trying to get the lease the longest|

The above metrics are calculated as a moving average from the last 100 packets.
Expand All @@ -52,4 +52,4 @@ The metrics are printed periodically into the `stdout` in the CSV format. It is

### License

Endure is licensed under the [MIT License](https://github.com/msiodelski/endure/blob/main/LICENSE).
Endure is licensed under the [MIT License](https://github.com/msiodelski/endure/blob/main/LICENSE).

0 comments on commit 8e37a0f

Please sign in to comment.