endure

KO | EN

gitlite — search

#python #ai #typescript #golang #machine-learning #deep-learning #linux #macos #awesome #cli #kubernetes #security #mcp #open-source

(★ 10)

Endure. A DHCP diagnostics utility.

endure 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## 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. It can also be used for the capture file analysis.

### System and Software Requirements

Endure has been tested on Ubuntu 22 and macOS Sonoma 14.1.1. It requires [libpcap](https://www.tcpdump.org) library.

To compile the program on Ubuntu 22, first install `lib Ipcap-dev`:

```
$ apt install libpcap-dev
```

### Building with Cargo

Endure is written in [Rust](https://www.rust-lang.org) and can be compiled using the [cargo](https://doc.rust-lang.org/cargo/) utility. It was tested with `rustc` version 1.82.

```
$ cd endure
$ cargo build --release
```

The resulting binary can be found in the `endure/target/release` directory.

Endure build system is integrated with [cargo-make](https://github.com/sagiegurari/cargo-make), a popular task runner for Rust. To use it for building and/or packaging the project:

```
$ cargo install --force cargo-make
```

To build the project:

```
$ cargo make build
```

### Installing from Packages

Starting from Endure 0.6.0, each release comes with `deb` and `rpm` packages for AMD64 and ARM64 architectures published on GitHub.

### Packaging with cargo-make

Building `deb` and `rpm` packages for the project is possible through [cargo-make](https://github.com/sagiegurari/cargo-make) tasks. These tasks internally run [nfpm](https://github.com/goreleaser/nfpm) package manager on Docker containers, specific to the architecture for which the packages are built.

To build all packages, run:

```
$ cargo make packages
```

The generated packages can be found under `target/release/dist`.

It is also possible to build selected packages. For example:

```
$ cargo make package-deb-arm64
```

builds a `deb` package for ARM64 architecture.

List available `cargo-make` tasks with:

```
$ cargo make --list-all-steps
```

### Running the Utility

Suppose your DHCP server is responding to the traffic on the interfaces `bridge101` and `bridge102`.
You can start monitoring the server with the following command:

```
$ endure collect -i bridge101 -i bridge102 -c stdout
```

The `-c stdout` argument configures the program to output collected metrics into the console periodically.

Listening on the local loopback interface has no practical application in production, however it may be useful for testing purposes. The `--loopback` switch is an alias for the `-i [loopback name]` (e.g., `-i lo`). However, the `--loopback` argument cannot be combined with `-i`.

```
$ endure collect --loopback -c stdout
```

### Integration with Prometheus and Grafana

Endure source code includes a [Docker Compose](https://docs.docker.com/compose/) configuration that launches
two containers, one with a [Prometheus](https://prometheus.io) instance, and one with [Grafana](https://grafana.com).
This setup requires that [Host network driver](https://docs.docker.com/engine/network/drivers/host/) is enabled
in Docker.

Launch the containers in background using the following commands:

```
$ cargo make services-up
```

In order to stop the containers:

```
$ cargo make services-down
```

Prometheus is configured to scrape the metrics from http://localhost:9100. Make sure that `endure`
makes the metrics available on that address and port. For example:

```
./endure collect --loopback  --prometheus --http-address 127.0.0.1:9100
```

Open Grafana dashboard in the browser on http://localhost:3000. Navigate to `Dashboards` to
monitor the metrics exported by `endure`.

### Capture File Analysis

Having a capture file named `capture.pcap` it is possible to gather the same metrics using the `read` command:

```
$ endure read --pcap capture.pcap --json
```

It will produce a report in the JSON format containing the metrics computed from all the DHCP packets in the capture file. The same report can be produced in the CSV format using the `--csv` switch.

Finally, using the `--stream` switch it is possible to generate a CSV output with several rows, each row presenting metrics for the number of packets specified using the `--sampling-window-size` switch. For example:

```
$ endure read --pcap capture.pcap --csv --stream --sampling-window-size 10
```

### Metrics

Endure is a new project with limited capabilities. However, it can already collect and report several useful metrics:

| Metric | Description |
|--------|-------------|
|`bootp_conversation_broadcast_count`|Total number of broadcast messages|
|`bootp_conversation_relayed_count`|Total number of relayed messages|
|`bootp_conversation_unicast_count`|Total number of unicast not-relayed messages|
|`bootp_conversation_broadcast_percent`|Percentage of broadcast messages|
|`bootp_conversation_relayed_percent`|Percentage of relayed messages|
|`bootp_conversation_unicast_percent`|Percentage of unicast not-relayed messages|
|`bootp_opcode_boot_requests_count`|Total number of `BootRequest` messages|
|`bootp_opcode_boot_replies_count`|Total number of `BootRequest` messages|
|`bootp_opcode_invalid_count`|Total number of invalid messages (having invalid `OpCode`)|
|`bootp_opcode_boot_requests_percent`|Percentage of `BootRequest` messages|
|`bootp_opcode_boot_replies_percent`|Percentage of the `BootReply` messages|
|`bootp_opcode_invalid_percent`|Percentage of neither request nor reply messages|
|`bootp_retransmit_percent`|Percentage of retransmissions|
|`bootp_retransmit_secs_avg`|Average number of seconds the DHCP clients have been retrying to acquire a lease|
|`bootp_retransmit_longest_trying_client`|MAC address of a client who has been trying to get the lease the longest|
|`dhcpv4_roundtrip_dora_milliseconds_avg`|Average time in milliseconds to complete a successful 4-way (DORA) exchange|
|`dhcpv4_roundtrip_dora_do_milliseconds_avg`|Average time in milliseconds to complete a Discover/Offer exchange during the 4-way (DORA) exchange|
|`dhcpv4_roundtrip_dora_ra_milliseconds_avg`|Average time in milliseconds to complete a Request/Ack exchange during the 4-way (DORA) exchange|
|`dhcpv4_spectrum_attempted_dora_count`|Total number of attempted DORA exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_inform_count`|Total number of attempted Inform exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_renew_count`|Total number of attempted Renew exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_rebind_count`|Total number of attempted Rebind exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_release_count`|Total number of attempted Release messages in all exchanges|
|`dhcpv4_spectrum_attempted_dora_percent`|Percentage of attempted DORA exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_inform_percent`|Percentage of attempted Inform exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_renew_percent`|Percentage of attempted Renew exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_rebind_percent`|Percentage of attempted Rebind exchanges in all exchanges|
|`dhcpv4_spectrum_attempted_release_percent`|Percentage of attempted Release messages in all exchanges|

Many of the metrics listed above (e.g., average or percentages) are computed using
the last N packets. The default number of packets is 100 but can be changed to an
arbitrary value using the `--sampling-window-size` command line switch. The lower
the value the more dynamic are the metric changes over time. This parameter is not
applicable to the full `pcap` file analysis.

The metrics can be reported over several different channels: CSV write to a file or console, export to [Prometheus](prometheus.io), [Server Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events), or the REST API. Consult the [User's Manual](https://github.com/msiodelski/endure/wiki/User-Manual-(endure)) for details.

### License

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

endure

endure 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

endure

endure 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README