MetricsHub Configuration
MetricsHub configuration file
| Type | object |
|---|---|
| File match |
*metricshub.yaml
*metricshub.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/metricshub-configuration/latest.json |
| Source | https://www.schemastore.org/metricshub.json |
Validate with Lintel
npx @lintel/lintel checkProperties
Job Pool Size
Logger Level (Default: error)
Output directory
Sets the collect period that MetricsHub uses to collects metrics from the monitored resources (Default: 2m).
Sets the cycle that MetricsHub uses to perform discoveries and detect new components in your monitored environment. By default, MetricsHub runs a discovery after 30 collects.
Alerting System Configuration
2 nested properties
If true, disables the alerting system
Problem alerts template
Enables or disables self monitoring signals. E.g. job duration metrics.
Sequential mode. This forces all network calls to be ordered in a sequential order.
Resolve hostnames to FQDN (Default: false).
Sets how long until the job times out (Default: 5m).
Customizes the OpenTelemetry Collector sub-process.
5 nested properties
Overrides the OpenTelemetry Collector command line.
Configures the OpenTelemetry Collector environment variables.
Configures where to print the OpenTelemetry Collector's output (Default: log).
Configures the working directory of the OpenTelemetry Collector.
Disables the OpenTelemetry Collector (Default: false).
Internal OpenTelemetry SDK configuration
7 nested properties
The OTLP metrics endpoint URL. Must be an http or https URL, depending on whether TLS is used. For gRPC, the URL is http://localhost:4317 and for HTTP/Protobuf it's http://localhost:4318/v1/metrics
Property used to configure the transport protocol to use on OTLP metric requests
Path to a PEM-formatted file containing trusted certificates for verifying the OTLP server TLS credentials.
Custom headers to send with OTLP metric requests, typically for authentication.
Timeout for OTLP metric requests (in seconds).
Exporter pool size. Determines how many metric export operations can run in parallel.
When enabled, all resource attributes will be added as attributes on each exported metric.
Web configuration loaded by default. Represents key-value pairs used for web-related settings.
{}32 nested properties
Server port number.
Spring application banner mode (supported values: console, log, off).
Enable or disable the MCP server.
Enable communication over STDIO.
MCP server name.
Notify on resource changes.
Notify on tool changes.
Notify on prompt changes.
SSE endpoint for server events.
SSE endpoint for messages.
MCP server type (sync or async).
Enable completion capability.
Enable prompt capability.
Enable resource capability.
Enable tool capability.
JSON Web Token short expire value (jwt).
JSON Web Token long expire value (refresh).
Secret key used for signing JWT tokens.
Enable/disable TLS for the embedded web server; false uses HTTP (Default: true).
Keystore path (supports classpath:); uses bundled keystore by default (Default: classpath:m8b-keystore.p12).
Keystore password (also used as key password) (Default: NOPWD).
Optional key password; falls back to keystore password when not set.
Optional key alias; if unset, first suitable private-key entry is used.
Maximum tool output bytes (Default: 10485760).
Safety delta bytes (Default: 2097152).
Base temporary directory (Default: ${java.io.tmpdir}/metricshub/ai).
OpenAI API key.
OpenAI model name (Default: gpt-5.2).
Enable OpenAI reasoning (Default: true).
Reasoning effort (Default: MEDIUM).
Reasoning summary (Default: AUTO).
Top level attributes
Top level metrics
Contains Resources
Contains Resource Groups
MetricsHub License
5 nested properties
The name of the product the license is for.
The name of the organization the license is for.
The expiration date of the license in the format yyyy-MM-dd.
The maximum number of resources the license covers.
The license key
Represents the possible compression methods for the state set metrics.
The path of the custom connectors directory, connectors will also be loaded from the default directory.
Monitor inclusion or exclusion in data collection. This parameter accepts '+<monitor_name>' for inclusion and '!<monitor_name>' for exclusion.
Definitions
Sequential mode. This forces all network calls to be ordered in a sequential order.
Enables or disables self monitoring signals. E.g. job duration metrics.
Forces a specific namespace for connectors that perform namespace auto-detection (Advanced).
Logger Level (Default: error)
Contains Resources
Result Content Expected
HTTP Method
Execute For Each Entry
Metric definitions describing the collected OpenTelemetry metrics and their metadata (unit, description, and type).
Contains Sources
Represents the possible compression methods for the state set metrics.
Monitor inclusion or exclusion in data collection. This parameter accepts '+<monitor_name>' for inclusion and '!<monitor_name>' for exclusion.
Resolve hostnames to FQDN (Default: false).
The hostname to which the query is sent.
An array of retry intervals (in milliseconds) between request retries.
Sets the cycle that MetricsHub uses to perform discoveries and detect new components in your monitored environment. By default, MetricsHub runs a discovery after 30 collects.