# appdynamics/config-assessment-tool architecture

> Architecture diagram of the GitHub repository appdynamics/config-assessment-tool, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/appdynamics/config-assessment-tool
- Repository: https://github.com/appdynamics/config-assessment-tool

## Overview

##### Main Components

a) Frontend Layer:
- Streamlit-based web interface (/frontend)
- File handling components
- View components for job execution states
- Docker container for frontend isolation

b) Backend Layer:
- Core assessment engine (/backend/core)
- API controllers and services (/backend/api)
- Extraction steps modules
- Output generators
- Docker container for backend isolation

c) External Systems:
- AppDynamics Controller (target system)
- Proxy servers (optional component)

##### Key Architectural Elements

a) Data Flow Components:
- Input handlers (job configurations, thresholds)
- Authentication flow (Basic/Token/Secret)
- API communication layer
- Report generators
- Output handlers

b) Assessment Modules:
- APM Assessment
- BRUM Assessment
- MRUM Assessment
- Custom Metrics Analysis
- License Analysis

**[User Interface Layer]**

**[Frontend Container]**

**[Backend Container]**

**[External Systems]**

##### Component Relationships

a) Frontend to Backend:
- Job configuration submission
- Report retrieval
- Status monitoring

b) Backend to AppDynamics:
- REST API calls
- Authentication
- Data collection
- Metric gathering

##### Important Details

a) File System Integration:
- Input directory mounting
- Output directory mounting
- Log directory mounting

b) Processing Pipeline:
- Job execution flow
- Data extraction steps
- Report generation

##### Technical Stack Indicators

- Python 3.9
- Docker containers
- Streamlit UI
- Excel report generation
- REST API integration

##### Specific Implementation Notes

Specialized components for:
- Maturity assessment modules
- Health rule analysis
- Agent version tracking
- Custom metric evaluation

##### External system integration

Remember to include:
- Clear component labels
- Data flow directions
- Authentication paths
- File system mounts
- Output generation paths

This architecture should emphasize the tool's primary purpose of performing health checks and generating assessment reports while maintaining a clear separation of concerns between frontend, backend, and external systems.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph User["User Interaction Layer"]
        UI[User Interface]
    end

    subgraph FrontendContainer["Frontend Container"]
        direction TB
        FI["Frontend Interface"]:::frontend
        FV["Frontend Views"]:::frontend
        FH["File Handler"]:::frontend

        FI --> FV
        FI --> FH
    end

    subgraph BackendContainer["Backend Container"]
        direction TB
        CAE["Core Assessment Engine"]:::backend
        
        subgraph API["API Layer"]
            direction TB
            APPD["AppD API Service"]:::api
            AUTH["Authentication Handler"]:::api
            CTRL["Controller Integration"]:::api
            
            AUTH --> APPD
            APPD --> CTRL
        end
        
        subgraph AssessmentModules["Assessment Modules"]
            direction TB
            APM["APM Assessment"]:::module
            BRUM["BRUM Assessment"]:::module
            MRUM["MRUM Assessment"]:::module
            CMA["Custom Metrics Analysis"]:::module
            LA["License Analysis"]:::module
            HRA["Health Rules Analysis"]:::module
        end
        
        subgraph Config["Configuration"]
            direction TB
            IC["Input Configuration"]:::config
            TC["Threshold Configuration"]:::config
        end
        
        subgraph Output["Output Generation"]
            direction TB
            RG["Report Generation"]:::output
        end

        CAE --> API
        CAE --> AssessmentModules
        Config --> CAE
        AssessmentModules --> RG
    end

    subgraph External["External Systems"]
        direction TB
        AC["AppDynamics Controller"]:::external
        PS["Proxy Server"]:::external
    end

    UI --> FI
    FH --> IC
    FI --> CAE
    CTRL --> AC
    CTRL -.-> PS
    PS -.-> AC

    classDef frontend fill:#3498db
    classDef backend fill:#2ecc71
    classDef api fill:#e74c3c
    classDef module fill:#9b59b6
    classDef config fill:#f1c40f
    classDef output fill:#1abc9c
    classDef external fill:#e67e22

    click FI "https://github.com/Appdynamics/config-assessment-tool/blob/master/frontend/frontend.py"
    click FV "https://github.com/Appdynamics/config-assessment-tool/tree/master/frontend/views"
    click FH "https://github.com/Appdynamics/config-assessment-tool/blob/master/frontend/FileHandler.py"
    click CAE "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/core/Engine.py"
    click APPD "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/api/appd/AppDService.py"
    click AUTH "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/api/appd/AuthMethod.py"
    click APM "https://github.com/Appdynamics/config-assessment-tool/tree/master/backend/extractionSteps/maturityAssessment/apm"
    click BRUM "https://github.com/Appdynamics/config-assessment-tool/tree/master/backend/extractionSteps/maturityAssessment/brum"
    click MRUM "https://github.com/Appdynamics/config-assessment-tool/tree/master/backend/extractionSteps/maturityAssessment/mrum"
    click CMA "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/extractionSteps/general/CustomMetrics.py"
    click RG "https://github.com/Appdynamics/config-assessment-tool/tree/master/backend/output/reports"
    click IC "https://github.com/Appdynamics/config-assessment-tool/tree/master/input/jobs"
    click TC "https://github.com/Appdynamics/config-assessment-tool/tree/master/input/thresholds"
    click LA "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/output/reports/LicenseReport.py"
    click HRA "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/extractionSteps/maturityAssessment/apm/HealthRulesAndAlertingAPM.py"
    click CTRL "https://github.com/Appdynamics/config-assessment-tool/blob/master/backend/api/appd/AppDController.py"
```
