mirror of https://github.com/aya-rs/aya
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
72 lines
1.5 KiB
Markdown
72 lines
1.5 KiB
Markdown
# aya-log - a logging library for eBPF programs
|
|
|
|
## Overview
|
|
|
|
`aya-log` is a logging library for eBPF programs written using [aya]. Think of
|
|
it as the [log] crate for eBPF.
|
|
|
|
## Installation
|
|
|
|
### User space
|
|
|
|
Add `aya-log` to `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
aya-log = { git = "https://github.com/aya-rs/aya", branch = "main" }
|
|
```
|
|
|
|
### eBPF side
|
|
|
|
Add `aya-log-ebpf` to `Cargo.toml`:
|
|
|
|
```toml
|
|
[dependencies]
|
|
aya-log-ebpf = { git = "https://github.com/aya-rs/aya", branch = "main" }
|
|
```
|
|
|
|
## Example
|
|
|
|
Here's an example that uses `aya-log` in conjunction with the [env_logger] crate
|
|
to log eBPF messages to the terminal.
|
|
|
|
### User space code
|
|
|
|
```rust
|
|
use aya_log::EbpfLogger;
|
|
|
|
env_logger::init();
|
|
|
|
// Will log using the default logger, which is TermLogger in this case
|
|
let logger = EbpfLogger::init(&mut bpf).unwrap();
|
|
let mut logger = tokio::io::unix::AsyncFd::with_interest(logger, tokio::io::Interest::READABLE).unwrap();
|
|
tokio::task::spawn(async move {
|
|
loop {
|
|
let mut guard = logger.readable_mut().await.unwrap();
|
|
guard.get_inner_mut().flush();
|
|
guard.clear_ready();
|
|
}
|
|
});
|
|
```
|
|
|
|
### eBPF code
|
|
|
|
```rust
|
|
use aya_log_ebpf::info;
|
|
|
|
fn try_xdp_firewall(ctx: XdpContext) -> Result<u32, ()> {
|
|
if let Some(port) = tcp_dest_port(&ctx)? {
|
|
if block_port(port) {
|
|
info!(&ctx, "❌ blocked incoming connection on port: {}", port);
|
|
return Ok(XDP_DROP);
|
|
}
|
|
}
|
|
|
|
Ok(XDP_PASS)
|
|
}
|
|
```
|
|
|
|
[aya]: https://github.com/aya-rs/aya
|
|
[log]: https://docs.rs/log
|
|
[env_logger]: https://docs.rs/env_logger
|