Skip to main content

ExcludedMetrics

Exclude Sensor Groups from the metrics returned to the /api/monitor/metrics endpoint and from OpenTelemetry metrics collection.

Synopsis

[Monitor]    ExcludedMetrics=ListOfMetrics

Where ListOfMetrics is a comma-separated list of Sensor Groups to exclude from the /api/monitor/metrics endpoint and OpenTelemetry metrics collection.

The default value of ListOfMetrics is the empty string, therefore no Sensor Groups are excluded by default. The Sensor Groups available for exclusion are Performance, Mirrors, Database, CPU, CSPGateway, Journal, License, Memory, Process, Shadows, Transactions, SharedMemory, WriteDemon, Diagnostic, SystemInfo, and ECP.

Description

When ListOfMetrics is not the empty string, InterSystems IRIS® data platform updates the ExcludeMetricsOpens in a new tab property from the SYS.Monitor.SAM.ConfigOpens in a new tab class to exclude the Sensor Groups contained in ListOfMetrics from the metrics returned to the /api/monitor/metrics endpoint and from OpenTelemetry metrics collection.

For more information on the metrics contained in each Sensor Group, see Metric Descriptions.

Changing This Parameter

On the Monitor page of the Management Portal (System Administration > Configuration > Additional Settings > Monitor), edit the Excluded Metrics field.

Instead of using the Management Portal, you can change ExcludedMetrics by editing the CPF in a text editor (as described in Editing the Active CPF).

See Also

FeedbackOpens in a new tab