# webdevops/azure-keyvault-exporter architecture

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

- Interactive diagram: https://gitdiagram.com/webdevops/azure-keyvault-exporter
- Repository: https://github.com/webdevops/azure-keyvault-exporter

## Overview

##### Project type and purpose
- This is an open-source, containerized Prometheus exporter written in Go.
- Its job is to periodically scrape metadata (info & status) for secrets, keys and certificates from Azure Key Vaults and expose them over HTTP for Prometheus to ingest.

##### File structure
- Top-level files:
– main.go: CLI entrypoint that initializes config, logging, caching, metrics collectors, HTTP server.
– common.*.go: shared helpers for logging (“common.logger.go”) and system utilities (“common.system.go”).
– metrics.keyvault.go: metric definitions and collector logic for KeyVault entities.
– config/opts.go: parses flags & env vars into typed configuration.
- Build & CI:
– Dockerfile, .dockerignore, Makefile – container build & local workflow.
– .github/workflows/*.yaml – CI pipelines for linting, building, testing, releasing Docker images.
- Dependencies:
– go.mod / go.sum – Go modules (Azure SDK, go-common libs, Prometheus client).
– metrics.keyvault.go uses go-common’s Azure ResourceGraph tag manager, tracing, cache interfaces.

##### README
- Describes CLI options for Azure authentication, filtering vaults, concurrency, caching, HTTP server settings.
- Lists exported Prometheus metrics (info & status per vault / secret / key / cert).
- Points to go-common docs for tag management, tracing metrics, caching.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Internal Modules"
        Config["Config Loader<br/>(config/opts.go)"]:::internal
        Logger["Logger Module<br/>(common.logger.go)"]:::internal
        SysUtils["System Utilities<br/>(common.system.go)"]:::internal
        CLI["Main CLI & Bootstrap<br/>(main.go)"]:::internal
        Auth["Azure Auth Module"]:::internal
        RG["Resource Graph Client"]:::internal
        Scraper["Vault Scraper Worker Pool"]:::internal
        Cache["Cache Layer"]:::internal
        Metrics["Prometheus Registry & HTTP Server"]:::internal
    end

    subgraph "External Services"
        AZ_RG["Azure Resource Graph"]:::external
        AZ_KV["Azure Key Vault"]:::external
        PROM["Prometheus Server"]:::external
    end

    subgraph "Infrastructure"
        Docker["Docker Build & Local Workflow"]:::infra
        CI["GitHub Actions CI/CD Pipelines"]:::infra
        GoMod["Go Modules<br/>(go.mod, go.sum)"]:::infra
        RepoDoc["Project Documentation<br/>(README.md)"]:::infra
    end

    CLI -->|initializes| Config
    CLI -->|initializes| Logger
    CLI -->|initializes| SysUtils
    CLI -->|reads modules| GoMod

    CLI -->|auth startup| Auth
    Auth -->|queries| RG
    RG -->|calls| AZ_RG
    RG -->|provides vault IDs| Scraper
    Scraper -->|scrapes secrets/keys/certs| AZ_KV
    Scraper -->|reads/writes| Cache
    Scraper -->|populates metrics| Metrics
    Metrics -->|exposes on :8080| PROM

    CI -->|builds images| Docker
    CI -->|validates modules| GoMod
    CI -->|links docs| RepoDoc
    Docker -->|uses| GoMod

    click Config "https://github.com/webdevops/azure-keyvault-exporter/blob/main/config/opts.go"
    click Logger "https://github.com/webdevops/azure-keyvault-exporter/blob/main/common.logger.go"
    click SysUtils "https://github.com/webdevops/azure-keyvault-exporter/blob/main/common.system.go"
    click CLI "https://github.com/webdevops/azure-keyvault-exporter/blob/main/main.go"
    click Scraper "https://github.com/webdevops/azure-keyvault-exporter/blob/main/metrics.keyvault.go"
    click Docker "https://github.com/webdevops/azure-keyvault-exporter/tree/main/Dockerfile"
    click CI "https://github.com/webdevops/azure-keyvault-exporter/blob/main/.github/workflows/build-docker.yaml"
    click GoMod "https://github.com/webdevops/azure-keyvault-exporter/blob/main/go.mod"
    click RepoDoc "https://github.com/webdevops/azure-keyvault-exporter/blob/main/README.md"

    classDef internal fill:#cce5ff,stroke:#004085,color:#004085
    classDef external fill:#d4edda,stroke:#155724,color:#155724
    classDef infra fill:#e2e3e5,stroke:#383d41,color:#383d41
```
