# gridscale/linux-psi-telegraf-plugin architecture

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

- Interactive diagram: https://gitdiagram.com/gridscale/linux-psi-telegraf-plugin
- Repository: https://github.com/gridscale/linux-psi-telegraf-plugin

## Overview

##### Main Components

a. Data Sources:
- Three separate files: `/proc/pressure/cpu`, `/proc/pressure/memory`, `/proc/pressure/io`

b. Plugin Components:
- PSI Plugin (main processing unit)
- Execd input plugin interface that Telegraf uses to execute the binary
- Metric collection logic

c. Output/Integration:
- Telegraf as the receiving system
- Metric output format
- Potential connection to InfluxDB (final destination)

##### Flow and Relationships

a. Data Flow Direction:
1. Linux Kernel PSI files → PSI Plugin
2. PSI Plugin → Telegraf execd input
3. Telegraf → InfluxDB

b. Processing Stages:
- Metric transformation:
- Raw PSI data → Structured metrics (pressure and pressureTotal)
- Metric tagging process (resource, type)

##### Specific Implementation Details

a. Metrics Processing:
- Two main measurement types:
- pressureTotal (with 'total' field)
- pressure (with avg10, avg60, avg300 fields)

b. Configuration:
- A small section showing the execd configuration

##### Additional Elements

- Version compatibility note (Telegraf 1.30+)
- Metric tagging system
- Timestamp handling

##### Technical Details to Highlight

- That it's a Go-based plugin
- It runs as an external process (execd)
- Metric structure with tags and fields

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Linux["Linux Kernel PSI Files"]
        CPU["/proc/pressure/cpu"]
        MEM["/proc/pressure/memory"]
        IO["/proc/pressure/io"]
    end

    subgraph Plugin["PSI Plugin Components"]
        direction TB
        Main["Main Entry Point"]:::entry
        PSI["PSI Plugin Implementation"]:::core
        Config["Plugin Configuration"]:::config
    end

    subgraph Integration["Telegraf Integration"]
        Execd["Execd Input Plugin"]
        Telegraf["Telegraf Service"]
        InfluxDB["InfluxDB"]
    end

    subgraph Metrics["Metric Types"]
        direction TB
        PT["pressureTotal\n(total field)"]
        P["pressure\n(avg10, avg60, avg300)"]
    end

    %% Data Flow
    CPU --> PSI
    MEM --> PSI
    IO --> PSI
    Main --> PSI
    PSI --> Metrics
    Metrics --> Execd
    Execd --> Telegraf
    Telegraf --> InfluxDB

    %% Styling
    classDef core fill:#2374ab
    classDef entry fill:#457b9d
    classDef config fill:#a8dadc
    classDef metrics fill:#e63946
    classDef integration fill:#f1faee

    %% Click Events
    click PSI "https://github.com/gridscale/linux-psi-telegraf-plugin/blob/main/plugins/inputs/psi/psi.go"
    click Main "https://github.com/gridscale/linux-psi-telegraf-plugin/blob/main/cmd/main.go"
    click Plugin "https://github.com/gridscale/linux-psi-telegraf-plugin/tree/main/plugins/inputs/psi/"
    click Config "https://github.com/gridscale/linux-psi-telegraf-plugin/blob/main/README.md"

    %% Legend
    subgraph Legend
        L1["Core Implementation"]:::core
        L2["Entry Point"]:::entry
        L3["Configuration"]:::config
        L4["Metrics"]:::metrics
        L5["Integration"]:::integration
    end

    %% Note
    subgraph Note["Deprecation Notice"]
        N1["Native PSI metrics collection\navailable in Telegraf 1.30+"]
    end
```
