Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Api] >  [InteropMetrics]
Private  Storage   

class %Api.InteropMetrics extends %CSP.REST

Provide Interoperability Interface metrics in Prometheus format

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6


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
interfaces interfacesByDay interfacesByInterval interfacesByMonth
interfacesByTime interfacesByYear


Methods

• classmethod interfaces(pNamespace As %String = "") as %Status
Collect the Interoperability Interface metrics and send them to the client in Prometheus Exposition Format. Optionally filter results to only include those in pNamespace
• classmethod interfacesByDay(pDay As %Integer = 0) as %Status
Collect the Interoperability Interface metrics for the specified day and send them to the client in Prometheus Exposition Format. pNumber must be a non-negative integer. A value of 0 means the returned results will represent any interfaces run within the current calendar day. If pNumber is a positive value, then the results will represent any interfaces run in the day pNumber prior to the current one. For example, if is 1, this will return results for the previous calendar day and if pNumber is 2, this will return results for the calendar day before the previous one. /// Local time is used in determining the boundary between days.
• classmethod interfacesByInterval(pInterval As %String = "", pNumber As %Integer = 0) as %Status
Collect the Interoperability Interface metrics for the specified interval and send them to the client in Prometheus Exposition Format. pInterval may be 'year', 'month', or 'day'. pNumber must be a non-negative integer. A value of 0 means the returned results will represent any interfaces run within the current time period. For example, if pInterval is 'year', this will return results for the current calendar year. If pNumber is a positive value, then the results will represent any interfaces run in the interval pNumber prior to the current one. For example, if pInterval is 'year' and pNumber is 1, this will return results for the previous calendar year, if pNumber is 2, this will return results for the calendar year before the previous one. Local time is used in determining the boundary between intervals.
• classmethod interfacesByMonth(pMonth As %Integer = 0) as %Status
Collect the Interoperability Interface metrics for the specified month and send them to the client in Prometheus Exposition Format. pNumber must be a non-negative integer. A value of 0 means the returned results will represent any interfaces run within the current calendar month. If pNumber is a positive value, then the results will represent any interfaces run in the month pNumber prior to the current one. For example, if is 1, this will return results for the previous calendar month and if pNumber is 2, this will return results for the calendar month before the previous one. /// Local time is used in determining the boundary between months.
• classmethod interfacesByTime(pStart As %String = "", pEnd As %String = "") as %Status
Collect the Interoperability Interface metrics in the specified time range - using local time - and send them to the client in Prometheus Exposition Format. pStart is required and must be a valid date and optionally time in ODBC format [YY]YY-MM-DD. Time, if specified uses the 24-hour clock and is separated from the date with either single space or a capital "T". If no time is specified, the beginning of the day is used. pStart is to be specified in local time, and must not be after the current time. pEnd is optional. If specified, it must be a valid date and optionally time in ODBC format [YY]YY-MM-DD. Time, if specified uses the 24-hour clock and is separated from the date with either single space or a capital "T". If no date or time is specified, the present time is used. If a date is specified, but time is not specified, the end of the day is used. pStart is to be specified in local time, and must not be after the current time.
• classmethod interfacesByYear(pYear As %Integer = 0) as %Status
Collect the Interoperability Interface metrics for the specified year and send them to the client in Prometheus Exposition Format. pNumber must be a non-negative integer. A value of 0 means the returned results will represent any interfaces run within the current calendar year. If pNumber is a positive value, then the results will represent any interfaces run in the year pNumber prior to the current one. For example, if is 1, this will return results for the previous calendar year and if pNumber is 2, this will return results for the calendar year before the previous one. /// Local time is used in determining the boundary between years.


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