# cloudflare/ebpf_exporter architecture

> Architecture diagram of the GitHub repository cloudflare/ebpf_exporter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cloudflare/ebpf_exporter
- Repository: https://github.com/cloudflare/ebpf_exporter

## Overview

a. Primary Flow:
- Linux Kernel -> eBPF Programs -> Maps -> Exporter Service -> Prometheus Metrics

b. Configuration Flow:
- Config Files -> Config System -> Exporter Service -> eBPF Program Loading

c. Decoding Flow:
- Raw Map Data -> Decoder System -> Formatted Metrics

a. Metrics Processing:
- Counters
- Histograms
- Labels
- Decoders (various types)

b. Program Types:
- Kprobes
- Tracepoints
- Fentry
- Uprobes

##### Integration Points (use interface symbols)

a. External Systems:
- Prometheus
- OpenTelemetry
- Linux Kernel APIs
- BPF CO-RE

##### Monitoring Components (use monitoring symbols)

a. Built-in Metrics:
- enabled_configs
- ebpf_program_info
- ebpf_program_attached
- ebpf_program_run_time_seconds
- decoder_errors_total

##### Implementation Details (use notes/callouts)

a. Key Features:
- CO-RE (Compile Once Run Everywhere) support
- Dynamic program loading
- Multiple config support
- Various decoder types
- Performance monitoring

##### Security Boundaries (use security symbols)

a. Required Capabilities:
- CAP_BPF
- CAP_PERFMON
- Optional: CAP_SYSLOG, CAP_IPC_LOCK, etc.

##### Important details
- Types (hash maps, per-CPU maps)
- Program types (kprobes, tracepoints)
- Metric types (counters, histograms)
- Decoder chains

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Monitoring Layer
        prometheus[Prometheus Metrics Endpoint]
        metrics[Metrics Processing]:::monitoring
    end

    subgraph Service Layer
        exporter[Exporter Service]:::service
        click exporter "https://github.com/cloudflare/ebpf_exporter/blob/master/cmd/ebpf_exporter/main.go"
        
        subgraph Core Components
            config[Config System]:::core
            click config "https://github.com/cloudflare/ebpf_exporter/blob/master/config/config.go"
            decoder[Decoder System]:::core
            click decoder "https://github.com/cloudflare/ebpf_exporter/blob/master/decoder/decoder.go"
            tracing[Tracing System]:::core
            click tracing "https://github.com/cloudflare/ebpf_exporter/blob/master/tracing/processor.go"
            cgroup[Cgroup Monitor]:::core
            click cgroup "https://github.com/cloudflare/ebpf_exporter/blob/master/cgroup/monitor.go"
        end

        subgraph Processing Components
            perf[Performance Event Handler]:::processing
            click perf "https://github.com/cloudflare/ebpf_exporter/blob/master/exporter/perf_event.go"
            hist[Histogram Processor]:::processing
            click hist "https://github.com/cloudflare/ebpf_exporter/blob/master/exporter/histogram.go"
            proginfo[Program Info Collector]:::processing
            click proginfo "https://github.com/cloudflare/ebpf_exporter/blob/master/exporter/program_info.go"
            xdp[XDP Handler]:::processing
            click xdp "https://github.com/cloudflare/ebpf_exporter/blob/master/exporter/xdp.go"
        end
    end

    subgraph Program Layer
        ebpf[eBPF Programs]:::ebpf
        click ebpf "https://github.com/cloudflare/ebpf_exporter/blob/master/examples/*.bpf.c"
        
        subgraph Program Types
            kprobes[Kprobes]:::probe
            tracepoints[Tracepoints]:::probe
            fentry[Fentry]:::probe
            uprobes[Uprobes]:::probe
            click kprobes "https://github.com/cloudflare/ebpf_exporter/blob/master/benchmark/probes/*.bpf.c"
            click tracepoints "https://github.com/cloudflare/ebpf_exporter/blob/master/benchmark/probes/*.bpf.c"
            click fentry "https://github.com/cloudflare/ebpf_exporter/blob/master/benchmark/probes/*.bpf.c"
            click uprobes "https://github.com/cloudflare/ebpf_exporter/blob/master/benchmark/probes/*.bpf.c"
        end
    end

    subgraph Kernel Layer
        kernel[Linux Kernel]:::kernel
        maps[BPF Maps]:::kernel
    end

    %% Connections
    kernel --> maps
    maps --> ebpf
    ebpf --> exporter
    exporter --> metrics
    metrics --> prometheus

    %% Core Component Connections
    config --> exporter
    decoder --> exporter
    tracing --> exporter
    cgroup --> exporter

    %% Program Type Connections
    kprobes & tracepoints & fentry & uprobes --> ebpf

    %% Processing Component Connections
    perf & hist & proginfo & xdp --> exporter

    %% Styles
    classDef kernel fill:#f9f,stroke:#333,stroke-width:2px
    classDef ebpf fill:#bbf,stroke:#333,stroke-width:2px
    classDef service fill:#bfb,stroke:#333,stroke-width:2px
    classDef core fill:#fbb,stroke:#333,stroke-width:2px
    classDef processing fill:#fbf,stroke:#333,stroke-width:2px
    classDef probe fill:#ff9,stroke:#333,stroke-width:2px
    classDef monitoring fill:#9ff,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        l1[Kernel Components]:::kernel
        l2[eBPF Components]:::ebpf
        l3[Service Components]:::service
        l4[Core Components]:::core
        l5[Processing Components]:::processing
        l6[Program Types]:::probe
        l7[Monitoring]:::monitoring
    end
```
