# karthickarumugam/sensu-plugins-mysql architecture

> Architecture diagram of the GitHub repository karthickarumugam/sensu-plugins-mysql, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/karthickarumugam/sensu-plugins-mysql
- Repository: https://github.com/karthickarumugam/sensu-plugins-mysql

## Overview

Sensu-Plugins-mysql is a collection of command-line MySQL checks and metric collectors. Operators invoke a check or collector with connection settings (optionally read from an ini file); the tool queries MySQL and reports a check result or emits metrics. The README documents checks for availability, connections, disk, locks, replication, status, threads, and query counts, plus several metric formats. Sampled source confirms direct database queries and result handling for some tools; unsampled tools are included as documented capabilities, with their internal links left unasserted.

Main entry points: [`bin/check-mysql-alive.rb`](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-alive.rb) (Availability check), [`bin/check-mysql-connections.rb`](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-connections.rb) (Connections check), [`bin/check-mysql-disk.rb`](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-disk.rb) (Disk usage check), [`bin/check-mysql-innodb-lock.rb`](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-innodb-lock.rb) (InnoDB lock check)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_checks["Health checks"]
  node_alive["Availability check"]
  node_connections["Connections check"]
  node_disk["Disk usage check"]
  node_locks["InnoDB lock check"]
  node_querycheck["Query count check"]
  node_replication["Replication check"]
  node_status["Status check"]
  node_threads["Threads check"]
end

subgraph group_metrics["Metric collectors"]
  node_graphitecollector["Status metrics"]
  node_processmetrics["Process metrics"]
  node_querymetrics["Query count metric"]
  node_collector["Historic metrics<br/>[metrics-mysql.rb]"]
end

subgraph group_raw["Raw metrics"]
  node_rawcollector["Raw metrics"]
  node_mysqlsql["Metrics SQL<br/>[mysql-metrics.sql]"]
end

node_operator(("Operator"))
node_mysql[("MySQL server")]
node_sensu["Sensu check result"]
node_graphite["Graphite metrics"]
node_historic[("Historic metrics DB")]

node_operator -->|"runs"| node_alive
node_operator -->|"runs"| node_connections
node_operator -->|"runs"| node_disk
node_operator -->|"runs"| node_locks
node_operator -->|"runs"| node_querycheck
node_operator -->|"runs"| node_replication
node_operator -->|"runs"| node_status
node_operator -->|"runs"| node_threads
node_operator -->|"runs"| node_graphitecollector
node_operator -->|"runs"| node_processmetrics
node_operator -->|"runs"| node_querymetrics
node_operator -->|"runs"| node_collector
node_operator -->|"runs"| node_rawcollector
node_alive -.->|"queries"| node_mysql
node_connections -.->|"queries"| node_mysql
node_disk -->|"queries"| node_mysql
node_locks -->|"queries"| node_mysql
node_querycheck -->|"queries"| node_mysql
node_replication -->|"queries"| node_mysql
node_status -->|"queries"| node_mysql
node_threads -.->|"queries"| node_mysql
node_graphitecollector -->|"queries"| node_mysql
node_processmetrics -->|"queries"| node_mysql
node_querymetrics -->|"queries"| node_mysql
node_rawcollector -->|"collects from"| node_mysql
node_alive -.->|"reports status"| node_sensu
node_connections -.->|"reports status"| node_sensu
node_disk -->|"reports status"| node_sensu
node_locks -->|"reports status"| node_sensu
node_querycheck -->|"reports status"| node_sensu
node_replication -->|"reports status"| node_sensu
node_status -->|"reports status"| node_sensu
node_threads -.->|"reports status"| node_sensu
node_graphitecollector -->|"emits metrics"| node_graphite
node_processmetrics -->|"emits metrics"| node_graphite
node_querymetrics -->|"emits metric"| node_graphite
node_collector -.->|"writes metrics"| node_historic
node_rawcollector -->|"emits metrics"| node_graphite

click node_alive "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-alive.rb"
click node_connections "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-connections.rb"
click node_disk "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-disk.rb"
click node_locks "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-innodb-lock.rb"
click node_querycheck "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-query-result-count.rb"
click node_replication "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-replication-status.rb"
click node_status "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-status.rb"
click node_threads "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-threads.rb"
click node_graphitecollector "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-graphite.rb"
click node_processmetrics "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-processes.rb"
click node_querymetrics "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-query-result-count.rb"
click node_collector "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql.rb"
click node_rawcollector "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-raw.rb"
click node_mysqlsql "https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/mysql-metrics.sql"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_alive,node_connections,node_disk,node_locks,node_querycheck,node_replication,node_status,node_threads toneBlue
class node_graphitecollector,node_processmetrics,node_querymetrics,node_collector,node_mysql,node_historic toneAmber
class node_rawcollector,node_mysqlsql toneMint
class node_operator,node_sensu,node_graphite toneIndigo
```

## Components

### Health checks

- [Availability check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-alive.rb): `bin/check-mysql-alive.rb`
- [Connections check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-connections.rb): `bin/check-mysql-connections.rb`
- [Disk usage check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-disk.rb): `bin/check-mysql-disk.rb`
- [InnoDB lock check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-innodb-lock.rb): `bin/check-mysql-innodb-lock.rb`
- [Query count check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-query-result-count.rb): `bin/check-mysql-query-result-count.rb`
- [Replication check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-replication-status.rb): `bin/check-mysql-replication-status.rb`
- [Status check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-status.rb): `bin/check-mysql-status.rb`
- [Threads check](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/check-mysql-threads.rb): `bin/check-mysql-threads.rb`

### Metric collectors

- [Status metrics](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-graphite.rb): `bin/metrics-mysql-graphite.rb`
- [Process metrics](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-processes.rb): `bin/metrics-mysql-processes.rb`
- [Query count metric](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-query-result-count.rb): `bin/metrics-mysql-query-result-count.rb`
- [Historic metrics](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql.rb): `bin/metrics-mysql.rb`

### Raw metrics

- [Raw metrics](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/metrics-mysql-raw.rb): `bin/metrics-mysql-raw.rb`
- [Metrics SQL](https://github.com/karthickarumugam/sensu-plugins-mysql/blob/master/bin/mysql-metrics.sql): `bin/mysql-metrics.sql`

### Other components

- **Operator**
- **MySQL server**
- **Sensu check result**
- **Graphite metrics**
- **Historic metrics DB**

## Connections

- Operator → Availability check: runs (evidence: `README.md`)
- Operator → Connections check: runs (evidence: `README.md`)
- Operator → Disk usage check: runs (evidence: `README.md`)
- Operator → InnoDB lock check: runs (evidence: `README.md`)
- Operator → Query count check: runs (evidence: `README.md`)
- Operator → Replication check: runs (evidence: `README.md`)
- Operator → Status check: runs (evidence: `README.md`)
- Operator → Threads check: runs (evidence: `README.md`)
- Operator → Status metrics: runs (evidence: `README.md`)
- Operator → Process metrics: runs (evidence: `README.md`)
- Operator → Query count metric: runs (evidence: `README.md`)
- Operator → Historic metrics: runs (evidence: `README.md`)
- Operator → Raw metrics: runs (evidence: `README.md`)
- Availability check → MySQL server: queries
- Connections check → MySQL server: queries
- Disk usage check → MySQL server: queries (evidence: `bin/check-mysql-disk.rb`)
- InnoDB lock check → MySQL server: queries (evidence: `bin/check-mysql-innodb-lock.rb`)
- Query count check → MySQL server: queries (evidence: `bin/check-mysql-query-result-count.rb`)
- Replication check → MySQL server: queries (evidence: `bin/check-mysql-replication-status.rb`)
- Status check → MySQL server: queries (evidence: `bin/check-mysql-status.rb`)
- Threads check → MySQL server: queries
- Status metrics → MySQL server: queries (evidence: `bin/metrics-mysql-graphite.rb`)
- Process metrics → MySQL server: queries (evidence: `bin/metrics-mysql-processes.rb`)
- Query count metric → MySQL server: queries (evidence: `bin/metrics-mysql-query-result-count.rb`)
- Raw metrics → MySQL server: collects from (evidence: `bin/metrics-mysql-raw.rb`)
- Availability check → Sensu check result: reports status
- Connections check → Sensu check result: reports status
- Disk usage check → Sensu check result: reports status (evidence: `bin/check-mysql-disk.rb`)
- InnoDB lock check → Sensu check result: reports status (evidence: `bin/check-mysql-innodb-lock.rb`)
- Query count check → Sensu check result: reports status (evidence: `bin/check-mysql-query-result-count.rb`)
- Replication check → Sensu check result: reports status (evidence: `bin/check-mysql-replication-status.rb`)
- Status check → Sensu check result: reports status (evidence: `bin/check-mysql-status.rb`)
- Threads check → Sensu check result: reports status
- Status metrics → Graphite metrics: emits metrics (evidence: `bin/metrics-mysql-graphite.rb`)
- Process metrics → Graphite metrics: emits metrics (evidence: `bin/metrics-mysql-processes.rb`)
- Query count metric → Graphite metrics: emits metric (evidence: `bin/metrics-mysql-query-result-count.rb`)
- Historic metrics → Historic metrics DB: writes metrics
- Raw metrics → Graphite metrics: emits metrics (evidence: `bin/metrics-mysql-raw.rb`)
