On this Page

MetricsHub
MetricsHub Community Connectors 1.0.22

MetricsHub Community Connectors

This repository contains MetricsHub community connectors and their documentation. It is the entry point for developers who want to:

  • create a new connector
  • improve an existing connector
  • learn the connector model used by MetricsHub
Important

The official implementation guide is the Connector Developer Guide[1]. Use it as the single source of truth for connector structure, detection, sources, computes, mapping, and testing.

Who This Site Is For

  • Developers adding monitoring support for new platforms
  • Contributors maintaining existing connectors
  • Reviewers validating connector quality, consistency, and compatibility

What You Will Find Here

If you are new to connector development, read in this order:

  1. Quick Start[1]
  2. Connector Structure[4]
  3. Monitors and Jobs[5]
  4. Reuse and Configuration[6]
  5. References and Expressions[7]
  6. Design Principles[8]
  7. Detection[9]
  8. Sources[10]
  9. Computes[11]
  10. Mapping, Metrics, and Semconv[12]
  11. Metric and Attribute Naming[13]
  12. Run and Debug Locally[14]
  13. Integration Testing[15]
  14. Contributing[16]
  15. Legacy and Compatibility[17]

Repository Layout (Developer View)

src/main/connector/           Connector YAML files and embedded scripts/files
src/site/markdown/            Documentation source (this site)
src/it/resources/             Replay integration test resources
src/it/java/                  Replay integration test code

Contribution Workflow (High Level)

  1. Implement or update connector YAML under src/main/connector/...
  2. Add or update replay test data under src/it/resources/<ConnectorId>/...
  3. Register/update IT execution in src/it/java/...
  4. Validate locally (mvn clean site, then mvn verify when relevant)
  5. Open a PR with clear behavior changes and evidence
Tip

For new work, prefer modern patterns documented in the guide: explicit source names, reusable beforeAll data, deterministic detection, and clear normalization pipelines.

metricshub community connectors connector development yaml opentelemetry metricshub community connector hardware system
Links:
  • [1] develop/quick-start.html
  • [2] supported-platforms.html
  • [3] connectors-directory.html
  • [4] develop/connector-structure.html
  • [5] develop/monitors-and-jobs.html
  • [6] develop/reuse-and-configuration.html
  • [7] develop/references-and-expressions.html
  • [8] develop/design-principles.html
  • [9] develop/detection/index.html
  • [10] develop/sources/index.html
  • [11] develop/computes/index.html
  • [12] develop/mapping-metrics-semconv.html
  • [13] develop/metric-naming.html
  • [14] develop/run-and-debug.html
  • [15] develop/integration-testing.html
  • [16] develop/contributing.html
  • [17] develop/legacy-and-compatibility.html
  • [18] https://github.com/metricshub/community-connectors
  • [19] https://metricshub.com
Searching...
No results.