https://github.com/aya-rs/aya-log

A logging library for eBPF programs.
https://github.com/aya-rs/aya-log

ebpf logging rust

Last synced: 2 months ago
JSON representation

A logging library for eBPF programs.

• Host: GitHub
• URL: https://github.com/aya-rs/aya-log
• Owner: aya-rs
• Archived: true
• Created: 2021-09-19T22:33:02.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-28T18:54:47.000Z (about 2 years ago)
• Last Synced: 2024-05-10T12:34:32.678Z (5 months ago)
• Topics: ebpf, logging, rust
• Language: Rust
• Homepage:
• Size: 34.2 KB
• Stars: 22
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**This repo has been moved. It is now located at https://github.com/aya-rs/aya**

# 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-log", branch = "main" }

```

### eBPF side

Add `aya-log-ebpf` to `Cargo.toml`:

```toml

[dependencies]

aya-log-ebpf = { git = "https://github.com/aya-rs/aya-log", branch = "main" }

```

## Example

Here's an example that uses `aya-log` in conjunction with the [simplelog] crate

to log eBPF messages to the terminal.

### User space code

```rust

use simplelog::{ColorChoice, ConfigBuilder, LevelFilter, TermLogger, TerminalMode};

use aya_log::BpfLogger;

TermLogger::init(

    LevelFilter::Debug,

    ConfigBuilder::new()

        .set_target_level(LevelFilter::Error)

        .set_location_level(LevelFilter::Error)

        .build(),

    TerminalMode::Mixed,

    ColorChoice::Auto,

)

.unwrap();

// Will log using the default logger, which is TermLogger in this case

BpfLogger::init(&mut bpf).unwrap();

```

### eBPF code

```rust

use aya_log_ebpf::info;

fn try_xdp_firewall(ctx: XdpContext) -> Result {

    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

[simplelog]: https://docs.rs/simplelog