# andywannasing/trace-anywhere architecture

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

- Interactive diagram: https://gitdiagram.com/andywannasing/trace-anywhere
- Repository: https://github.com/andywannasing/trace-anywhere

## Overview

##### Main Components

a. Core Components:
- Trace Agent (Java Agent)
- Core Framework
- Plugin System
- Server Component

b. Plugins:
- HTTP Plugin
- MySQL Plugin
- Redis Plugin
- Kafka Plugin
- TCP Plugin
- Execution Plugin

##### Top Level (Instrumentation Layer)
- How it connects to the application being monitored

##### Middle Layer (Core Framework)
- Include:
- TraceManager
- TraceContextHolder
- Span Management
- Log Management

##### Plugin Layer
- Plugins in a horizontal layout
- Related plugins:
- Database (MySQL, Redis)
- Messaging (Kafka)
- Network (HTTP, TCP)
- Execution monitoring

##### Bottom Layer (Server)
- Data collection and storage flow

##### Data Flow
- Instrumentation flow (Agent → Application)
- Trace data flow (Application → Plugins → Core → Server)
- Context propagation between components

Key Elements to Emphasize:

##### Instrumentation Mechanism
- How the agent injects code using ASM/ByteBuddy
- Transformation points

##### Plugin Architecture
- Plugin interface and extension points
- How plugins interact with core components

##### Trace Context
- Context propagation
- Span relationship management

##### Data Collection
- How different types of traces are collected:
- HTTP requests
- Database queries
- Message processing
- Method execution

##### Labels for
- Major components
- Integration points
- Data flow directions
- Key interfaces

##### Maintain proper abstraction
- Component interaction
- Skip internal implementation details
- Main data flows
- Extension points

Remember to indicate the asynchronous nature of trace collection and how the system maintains performance while gathering detailed execution data.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef agent fill:#b3d9ff,stroke:#333
    classDef core fill:#90EE90,stroke:#333
    classDef plugin fill:#FFB366,stroke:#333
    classDef server fill:#DDA0DD,stroke:#333
    classDef model fill:#F0E68C,stroke:#333

    %% Instrumentation Layer
    Agent["Trace Agent"]:::agent
    click Agent "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-agent/src/main/java/com/andy/trace/agent/TraceAgent.java"

    %% Core Framework Layer
    subgraph CoreFramework["Core Framework"]
        TM["Trace Manager"]:::core
        TCH["Trace Context Holder"]:::core
        SM["Span Management"]:::core
        PS["Plugin System"]:::core
    end
    click TM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/TraceManager.java"
    click TCH "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/TraceContextHolder.java"
    click SM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/Span.java"
    click PS "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/plugin/Plugin.java"

    %% Plugin Layer
    subgraph Plugins["Plugin Layer"]
        direction TB
        HTTP["HTTP Plugin"]:::plugin
        MySQL["MySQL Plugin"]:::plugin
        Redis["Redis Plugin"]:::plugin
        Kafka["Kafka Plugin"]:::plugin
        TCP["TCP Plugin"]:::plugin
        Exec["Execution Plugin"]:::plugin
    end
    click HTTP "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-plugin/trace-anywhere-plugin-http/src/main/java/com/andy/trace/http/plugin/HttpPlugin.java"
    click MySQL "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-plugin/trace-anywhere-plugin-mysql/src/main/java/com/andy/trace/mysql/plugin/SqlPlugin.java"
    click Exec "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-plugin/trace-anywhere-plugin-execution/src/main/java/com/andy/trace/execution/plugin/ExecutionPlugin.java"

    %% Trace Models
    subgraph Models["Trace Models"]
        direction TB
        HTM["HTTP Trace Model"]:::model
        STM["SQL Trace Model"]:::model
        RTM["Redis Trace Model"]:::model
        MTM["MQ Trace Model"]:::model
        TTM["TCP Trace Model"]:::model
    end
    click HTM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/model/HttpTraceMessage.java"
    click STM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/model/SqlTraceMessage.java"
    click RTM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/model/RedisTraceMessage.java"
    click MTM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/model/MqTraceMessage.java"
    click TTM "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-core/src/main/java/com/andy/trace/model/TcpTraceMessage.java"

    %% Server Layer
    Server["Trace Server"]:::server
    click Server "https://github.com/AndyWannaSing/trace-anywhere/blob/main/trace-anywhere-server/src/main/java/com/andy/trace/App.java"

    %% Relationships
    Agent --> TM
    TM --> TCH
    TM --> SM
    TM --> PS
    PS --> HTTP & MySQL & Redis & Kafka & TCP & Exec
    HTTP --> HTM
    MySQL --> STM
    Redis --> RTM
    Kafka --> MTM
    TCP --> TTM
    HTM & STM & RTM & MTM & TTM --> Server

    %% Legend
    subgraph Legend
        L1["Agent Component"]:::agent
        L2["Core Component"]:::core
        L3["Plugin Component"]:::plugin
        L4["Server Component"]:::server
        L5["Model Component"]:::model
    end
```
