Class Reference
%Api.Monitor
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
  
-
  [USER] >  [%Api] >  [Monitor]
Private  Storage

class %Api.Monitor extends %CSP.REST

Provide IRIS metrics and alerts for Prometheus, SAM Manager and other monitoring.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
AcceptsContentType AccessCheck ConvertParameter Decrypt
DispatchRequest DrawCSS3STYLE DrawHEAD DrawSTHEAD
DrawSTTitle DrawSTYLE DrawTitle DrawTitleSection
Encrypt Error EscapeHTML EscapeURL
GetAuthChallenge Http403 Http404 Http405
Http500 HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
Login OnErrorSetup OnHTTPHeader OnHandleCorsRequest
OnHandleOptionsRequest OnLoginPage OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreDispatch OnPreHTTP
OnPreHyperEvent OnSecurityTokenPage Page QuoteJS
ReportHttpStatusCode RewriteURL SetResponseHeaderIfEmpty ShowError
StartTimer StatusToJSON StatusToProxyObject StopTimer
SupportedVerbs ThrowError UnescapeHTML UnescapeURL
alerts metrics


Methods

• classmethod alerts() as %Status
Collect all system alerts from alerts.log and send them to the client as JSON.
• classmethod metrics() as %Status
Collect the system metrics and send them to the client in Prometheus Exposition Format.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.