How metricshub/metricshub-community works
MetricsHub is an OpenTelemetry-based monitoring agent and engine. Users configure resources and connectors through files, the CLI, or the web UI; the agent schedules monitoring, the engine discovers and collects data through protocol extensions, and telemetry is exported to an OpenTelemetry Collector. The repository also includes web/MCP querying, remote OpAMP management and upgrades, tunneling, and hardware sustainability processing. Relationships for unsampled subsystems are included only where the README documents them; the supplied tree and excerpts do not expose all runtime wiring.
Main entry points: MetricsHubAgentApplication.java Agent runtime · metricshub-engine MetricsHub engine · ExtensionManager.java Protocol extensions · OpAmpService.java OpAMP management
Components 24
Configuration and control
- Agent runtime
metricshub-agent/src/main/java/org/metricshub/agent/MetricsHubAgentApplication.java - Configuration service
metricshub-agent/src/main/java/org/metricshub/agent/service/ConfigurationService.java - Configuration reload
metricshub-agent/src/main/java/org/metricshub/agent/service/ConfigurationReloadService.java - Active agent context
metricshub-agent/src/main/java/org/metricshub/web/AgentContextHolder.java
Monitoring and collection
- Monitoring scheduler
metricshub-agent/src/main/java/org/metricshub/agent/service/TaskSchedulingService.java - Monitoring tasks
metricshub-agent/src/main/java/org/metricshub/agent/service/task/MonitoringTask.java - MetricsHub engine
metricshub-engine - Protocol extensions
metricshub-engine/src/main/java/org/metricshub/engine/extension/ExtensionManager.java - Protocol connectors
metricshub-http-extension/src/main/java/org/metricshub/extension/http/HttpRequestExecutor.java - OS commands
metricshub-oscommand-extension/src/main/java/org/metricshub/extension/oscommand/OsCommandService.java - Monitor telemetry
metricshub-engine/src/main/java/org/metricshub/engine/telemetry/TelemetryManager.java - Energy enrichment
metricshub-hardware/src/main/java/org/metricshub/hardware/HardwareEnergyPostExecutionService.java
Telemetry output
- OpenTelemetry export
metricshub-agent/src/main/java/org/metricshub/agent/opentelemetry/MetricsExporter.java
Remote management
- OpAMP management
metricshub-agent/src/main/java/org/metricshub/agent/opamp/OpAmpService.java - OpAMP client
metricshub-opamp-client/src/main/java/org/metricshub/opamp/client/OpampClient.java - Automatic upgrades
metricshub-agent/src/main/java/org/metricshub/agent/upgrade/UpgradeManager.java - Remote tunnel
metricshub-agent/src/main/java/org/metricshub/agent/tunnel/TunnelService.java
User interfaces
- Web server
metricshub-agent/src/main/java/org/metricshub/web/MetricsHubAgentServer.java - Web API
metricshub-agent/src/main/java/org/metricshub/web/controller - Web UI
metricshub-web/react/src/App.jsx - MCP query tools
metricshub-agent/src/main/java/org/metricshub/web/mcp/ExecuteHttpQueryService.java - Command-line interface
metricshub-agent/src/main/java/org/metricshub/cli/MetricsHubCliApplication.java
Other components
- Operator
- OTel Collector
Connections 26
- Operator → Web UI: configures
- Operator → Command-line interface: configures
- Web UI → Web server: uses
- Web server → Web API: serves
- Web API → Active agent context: reads context
- Agent runtime → Configuration service: loads config
- Configuration service → Configuration reload: supports reload
- Configuration reload → Active agent context: publishes context
metricshub-agent/src/main/java/org/metricshub/web/AgentContextHolder.java - Agent runtime → Monitoring scheduler: starts scheduling
- Monitoring scheduler → Monitoring tasks: schedules
- Monitoring tasks → MetricsHub engine: invokes monitoring
- MetricsHub engine → Protocol extensions: loads extensions
metricshub-engine/src/main/java/org/metricshub/engine/extension/ExtensionManager.java - Protocol extensions → Protocol connectors: dispatches queries
- Protocol extensions → OS commands: dispatches commands
- OS commands → Operator: queries host
- MetricsHub engine → Monitor telemetry: records monitors
metricshub-engine/src/main/java/org/metricshub/engine/extension/ExtensionManager.java - Monitor telemetry → Energy enrichment: enriches metrics
metricshub-hardware/src/main/java/org/metricshub/hardware/HardwareEnergyPostExecutionService.java - Agent runtime → OpenTelemetry export: exports metrics
- OpenTelemetry export → OTel Collector: sends telemetry
- Web API → MCP query tools: offers queries
- MCP query tools → Active agent context: resolves context
metricshub-agent/src/main/java/org/metricshub/web/mcp/ExecuteHttpQueryService.java - MCP query tools → Protocol connectors: executes HTTP
metricshub-agent/src/main/java/org/metricshub/web/mcp/ExecuteHttpQueryService.java - Agent runtime → OpAMP management: runs management
- OpAMP management → OpAMP client: uses client
- OpAMP management → Automatic upgrades: handles offers
- Agent runtime → Remote tunnel: provides tunneling