# jenkinsci/audit-trail-plugin architecture

> Architecture diagram of the GitHub repository jenkinsci/audit-trail-plugin, 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/jenkinsci/audit-trail-plugin
- Repository: https://github.com/jenkinsci/audit-trail-plugin

## Overview

##### Main Components

a) Core Plugin Components:
- AuditTrailPlugin (Central coordinator)
- AuditTrailFilter (HTTP request interceptor)
- AuditTrailRunListener (Build events listener)
- CredentialUsageListener (Credentials usage tracker)

b) Logger Implementations:
- ConsoleAuditLogger
- LogFileAuditLogger
- LogFileDailyRotationAuditLogger
- SyslogAuditLogger
- ElasticSearchAuditLogger

c) External Systems:
- Jenkins Core
- File System
- Syslog Server
- Elasticsearch Server
- Console Output

##### Input Layer
- Jenkins HTTP requests
- Build triggers
- Credential usage events

##### Processing Layer
- AuditTrailFilter
- AuditTrailRunListener
- CredentialUsageListener

##### Core Layer
- AuditTrailPlugin (central component)

##### Output Layer
- Various logger implementations
- External systems

##### Specific Elements

- Rectangles: Core components
- Hexagons: External services
- Rounded rectangles: Listeners and filters

- Blue: Core plugin components
- Green: Input sources
- Orange: Logger implementations
- Gray: External systems

- Event flow from input sources
- Data flow to logging destinations
- Configuration flow

##### Relationships to Highlight

- How AuditTrailPlugin coordinates with different loggers
- Demonstrate the event capture flow from Jenkins to logging destinations
- Configuration relationships

##### Additional Details

A notes section showing:
- Supported log formats
- Configuration options
- Security considerations (like IP address limitations)

##### Event capture mechanisms

Keep the abstraction level focused on the architectural components while showing the plugin's core functionality of capturing and logging Jenkins operations through various output channels.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Input Layer
    subgraph Input
        HTTP[HTTP Requests]:::input
        BT[Build Triggers]:::input
        CU[Credential Usage]:::input
    end

    %% Processing Layer
    subgraph Processing
        ATF[AuditTrailFilter]:::processor
        ATRL[AuditTrailRunListener]:::processor
        CUL[CredentialUsageListener]:::processor
    end
    click ATF "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/AuditTrailFilter.java"
    click ATRL "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/AuditTrailRunListener.java"
    click CUL "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/CredentialUsageListener.java"

    %% Core Layer
    subgraph Core
        ATP[AuditTrailPlugin]:::core
    end
    click ATP "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/AuditTrailPlugin.java"

    %% Logger Layer
    subgraph Loggers
        CAL[ConsoleAuditLogger]:::logger
        LFAL[LogFileAuditLogger]:::logger
        LFDR[LogFileDailyRotationAuditLogger]:::logger
        SAL[SyslogAuditLogger]:::logger
        ESAL[ElasticSearchAuditLogger]:::logger
    end
    click CAL "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/ConsoleAuditLogger.java"
    click LFAL "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/LogFileAuditLogger.java"
    click LFDR "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/LogFileDailyRotationAuditLogger.java"
    click SAL "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/SyslogAuditLogger.java"
    click ESAL "https://github.com/jenkinsci/audit-trail-plugin/blob/master/src/main/java/hudson/plugins/audit_trail/ElasticSearchAuditLogger.java"

    %% External Systems
    subgraph External
        FS[(File System)]:::external
        SS[Syslog Server]:::external
        ES[(Elasticsearch)]:::external
        CO[Console Output]:::external
    end

    %% Connections
    HTTP --> ATF
    BT --> ATRL
    CU --> CUL

    ATF --> ATP
    ATRL --> ATP
    CUL --> ATP

    ATP --> CAL
    ATP --> LFAL
    ATP --> LFDR
    ATP --> SAL
    ATP --> ESAL

    CAL --> CO
    LFAL --> FS
    LFDR --> FS
    SAL --> SS
    ESAL --> ES

    %% Styles
    classDef input fill:#90EE90,stroke:#333,stroke-width:2px
    classDef processor fill:#ADD8E6,stroke:#333,stroke-width:2px,rx:10,ry:10
    classDef core fill:#0066CC,stroke:#333,stroke-width:2px,color:white
    classDef logger fill:#FFA500,stroke:#333,stroke-width:2px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        I[Input Sources]:::input
        P[Processors]:::processor
        C[Core Components]:::core
        L[Loggers]:::logger
        E[External Systems]:::external
    end
```
