# performancecopilot/parfait architecture

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

- Interactive diagram: https://gitdiagram.com/performancecopilot/parfait
- Repository: https://github.com/performancecopilot/parfait

## Overview

##### Project Type and Purpose
- Parfait is an open-source, multi-module Java performance-monitoring library.
- It provides a core metrics API (*parfait-core*), plus adapter modules to export those metrics to various sinks (JMX, PCP MMV files, Dropwizard, CXF, JDBC, Spring AOP, etc.).
- It also provides a Java agent (*parfait-agent*) for automatic instrumentation, example apps, and benchmarking.

##### File Structure Analysis
- Top-level directories and files:
- bin/, man/, site/ – scripts and documentation
- dxm/ – direct export to PCP mmv (DXM) implementation
- parfait-agent/ – Java agent for automatic metric collection via JMX and internal APIs
- parfait-benchmark/ – performance tests
- parfait-core/ – core metrics API (MonitorableRegistry, Monitorable<T>, MonitoringView, Scheduler)
- parfait-io/, parfait-jdbc/, parfait-jmx/, parfait-pcp/, parfait-cxf/, parfait-dropwizard/, parfait-spring/ – adapter modules
- examples/ – small sample applications
- pom.xml – top-level Maven aggregator
- Each module is a Maven subproject with src/main/java, src/test/java, resources, and a pom.xml.

##### README Insights
Core → output interfaces → adapter modules → external sinks
- The core concepts: MonitorableRegistry, Monitorable<T> types (Counter, Value, PollingValue), MonitoringView, Monitor.

##### Components
1. parfait-core
2. Adapter Modules:
– dxm (PCP MMV writer)
– jdbc (ParfaitDataSource)
– jmx (JmxView, InProgressMonitor)
– dropwizard (ParfaitReporter → Dropwizard metrics)
– cxf (MonitoringInterceptor)
– spring (MonitoringAspect)
– io (I/O utility streams)
– pcp (bridge to PCP monitor)
3. parfait-agent (javaagent entry point, uses core + adapters)
4. External Systems:
– JVM/JMX server
– PCP MMV file system
– Dropwizard metrics registry
– CXF web service endpoints
– JDBC data sources
– Spring application context (beans)
5. Examples & Benchmark (optional, illustrative usage)
b. Relationships & Data Flow
- The application code (or the javaagent) registers metrics in MonitorableRegistry.
- MonitoringView implementations in each adapter subscribe to registry events.
- Adaptation layers translate Monitorable<T> into the external sink format:
- dxm writes PCP mmv files → consumed by PCP tools
- jmx publishes MBeans → JMX clients
- dropwizard reports to Dropwizard registry
- cxf intercepts SOAP/REST calls to measure latency
- spring AOP wraps bean methods for timing
- jdbc wraps DataSource to count queries
- parfait-agent boots at JVM startup, loads JMX and other modules automatically, writes metrics continuously to PCP mmv.
c. Architectural Patterns & Principles
- Modular layering (core API → adapter modules → external sinks)
- Observer pattern: MonitoringView subscribes to MonitorableRegistry
- Decorator/proxy pattern: JDBC, CXF, and Spring adapters wrap existing components
- Java agent instrumentation via -javaagent and bytecode hooks (parfait-agent)
d. Key Technologies & Frameworks
- Java 11–17, Maven multi-module
- Java Instrumentation API (javaagent)
- JMX (javax.management)
- PCP mmv (Memory-Mapped Values)
- Dropwizard metrics API
- Apache CXF interceptors
- Spring AOP and @Aspect
- JDBC DataSource wrapper

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Java Agent
    ParfaitAgent["ParfaitAgent"]:::agent
    click ParfaitAgent "https://github.com/performancecopilot/parfait/blob/main/parfait-agent/src/main/java/io/pcp/parfait/ParfaitAgent.java"

    %% Core Layer
    subgraph "Core Layer"
        MonitorableRegistry["MonitorableRegistry"]:::core
        MonitorableT["Monitorable<T>"]:::core
        MonitoringViewClass["MonitoringView"]:::core
        MonitorClass["Monitor"]:::core
    end
    click MonitorableRegistry "https://github.com/performancecopilot/parfait/tree/main/parfait-core/"
    
    %% Adapter Modules
    subgraph "Adapter Modules"
        DXMAdapter["PcpMmvWriter"]:::adapter
        JDBCAdapter["ParfaitDataSource"]:::adapter
        JMXAdapter["JmxView"]:::adapter
        DropwizardAdapter["ParfaitReporter"]:::adapter
        CXFAdapter["MonitoringInterceptor"]:::adapter
        SpringAdapter["MonitoringAspect"]:::adapter
        IOAdapter["ByteCountingInputStream"]:::adapter
        PCPAdapter["PcpMonitorBridge"]:::adapter
    end
    click DXMAdapter "https://github.com/performancecopilot/parfait/blob/main/dxm/src/main/java/io/pcp/parfait/dxm/PcpMmvWriter.java"
    click JDBCAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-jdbc/src/main/java/io/pcp/parfait/jdbc/ParfaitDataSource.java"
    click JMXAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-jmx/src/main/java/io/pcp/parfait/jmx/JmxView.java"
    click DropwizardAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-dropwizard/src/main/java/io/pcp/parfait/dropwizard/ParfaitReporter.java"
    click CXFAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-cxf/src/main/java/io/pcp/parfait/cxf/MonitoringInterceptor.java"
    click SpringAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-spring/src/main/java/io/pcp/parfait/spring/MonitoringAspect.java"
    click IOAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-io/src/main/java/io/pcp/parfait/io/ByteCountingInputStream.java"
    click PCPAdapter "https://github.com/performancecopilot/parfait/blob/main/parfait-pcp/src/main/java/io/pcp/parfait/pcp/PcpMonitorBridge.java"

    %% External Systems
    PCPMMV["PCP MMV Files"]:::external
    JDBCDB["JDBC DataSource"]:::external
    JMXConsole["JMX Server"]:::external
    DWRegistry["Dropwizard Metrics Registry"]:::external
    CXFEndpoint["CXF Service Endpoints"]:::external
    SpringContext["Spring ApplicationContext"]:::external
    PCPMonitor["PCP Monitor Tools"]:::external

    %% Connections
    ParfaitAgent -->|"bootstraps"| MonitorableRegistry
    MonitorableRegistry -->|registers metrics| DXMAdapter
    MonitorableRegistry -->|registers metrics| JDBCAdapter
    MonitorableRegistry -->|registers metrics| JMXAdapter
    MonitorableRegistry -->|registers metrics| DropwizardAdapter
    MonitorableRegistry -->|registers metrics| CXFAdapter
    MonitorableRegistry -->|registers metrics| SpringAdapter
    MonitorableRegistry -->|registers metrics| IOAdapter
    MonitorableRegistry -->|registers metrics| PCPAdapter

    DXMAdapter -->|"writes mmv"| PCPMMV
    PCPMMV --> PCPMonitor
    JDBCAdapter -->|"wraps DS"| JDBCDB
    JMXAdapter -->|"publishes MBeans"| JMXConsole
    DropwizardAdapter -->|"reports to"| DWRegistry
    CXFAdapter -->|"intercepts calls"| CXFEndpoint
    SpringAdapter -->|"advices beans"| SpringContext

    %% Styles
    classDef core fill:#a6cee3,stroke:#1f78b4,color:#000
    classDef adapter fill:#b2df8a,stroke:#33a02c,color:#000
    classDef agent fill:#fdbf6f,stroke:#ff7f00,color:#000
    classDef external fill:#cccccc,stroke:#333333,color:#000
```
