Agent Maturity Compass API - v1.2.0
Guides
HTTP API
GitHub
Preparing search index...
index
RealtimeMonitor
Class RealtimeMonitor
Index
Constructors
constructor
Methods
acknowledge
Alert
get
Alerts
get
Fleet
Overview
get
Metrics
ingest
prune
Constructors
constructor
new
RealtimeMonitor
(
retentionDays
?:
number
,
thresholds
?:
AlertThreshold
[]
,
)
:
RealtimeMonitor
Parameters
retentionDays
:
number
= 30
thresholds
:
AlertThreshold
[]
= []
Returns
RealtimeMonitor
Methods
acknowledge
Alert
acknowledgeAlert
(
alertId
:
string
)
:
boolean
Parameters
alertId
:
string
Returns
boolean
get
Alerts
getAlerts
(
filter
?:
{
agentId
?:
string
;
severity
?:
string
;
unacknowledgedOnly
?:
boolean
;
}
,
)
:
MonitoringAlert
[]
Parameters
Optional
filter
:
{
agentId
?:
string
;
severity
?:
string
;
unacknowledgedOnly
?:
boolean
}
Returns
MonitoringAlert
[]
get
Fleet
Overview
getFleetOverview
()
:
{
criticalAgents
:
number
;
healthyAgents
:
number
;
latestScores
:
Map
<
string
,
number
>
;
totalAgents
:
number
;
warningAgents
:
number
;
}
Returns
{
criticalAgents
:
number
;
healthyAgents
:
number
;
latestScores
:
Map
<
string
,
number
>
;
totalAgents
:
number
;
warningAgents
:
number
;
}
get
Metrics
getMetrics
(
agentId
:
string
,
metricName
:
string
,
since
?:
number
,
)
:
DashboardMetric
[]
Parameters
agentId
:
string
metricName
:
string
Optional
since
:
number
Returns
DashboardMetric
[]
ingest
ingest
(
metric
:
DashboardMetric
)
:
MonitoringAlert
|
null
Parameters
metric
:
DashboardMetric
Returns
MonitoringAlert
|
null
prune
prune
()
:
number
Returns
number
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
acknowledge
Alert
get
Alerts
get
Fleet
Overview
get
Metrics
ingest
prune
Guides
HTTP API
GitHub
Agent Maturity Compass API - v1.2.0
Loading...