MonitorsApi: Agave Monitors API operations
In agaveplatform/r-sdk: Agave Platform client SDK for R

Description Usage Format Details Arguments Methods See Also

MonitorsApi Class

1	monitors <- MonitorsApi$new( apiClient = ApiClient$new(), cache = AgaveCache$new() )

An object of class R6ClassGenerator of length 24.

The Agave Monitors API provides a familiar paradigm for monitoring the use ability and accessibility of storage and execution systems you registered with Agave. Similar to services like Pingdom, Pagerduty, and WebCron, the Monitors API allows you to to create regular health checks on a registered system. Unlike standard uptime services, Agave will check that your system is responsive and accessible by performing proactive tests on availability (ping), accessibility (authentication), and functionality (listing or echo). Each check result is persisted and the check history of a given monitor is queryable through the API. As with all resources in the Agave Platform, a full event model is available so you can subscribe to event you care about such as failed checks, restored system availability, and system disablement.

Read more about the Monitors API in the Agave Developer's Guide

apiClient a rAgave::ApiClient instance preconfigured to speak to the Agave Platform.

cache an rAgave::AgaveCache instance pointing to the persistent auth cache file on disk.

responseType the default object type methods of this class should return. Valid values are:

raw: the raw JSON string response from the API. You may optionally include pretty=TRUE in the method call to receive pretty printed JSON.
list: a standard R list object. This is the default value.
dt: a data table

$addMonitoringTasks() Add a new monitoring task

Usage

1	monitors$addMonitoringTasks$listMonitors(body, naked, )

$deleteMonitoringTask() Deletes a monitor.

Usage

1	monitors$deleteMonitoringTask$listMonitors(monitorId, naked, )

$forceMonitoringTaskCheck() Forces a monitor check to run.

Usage

1	monitors$forceMonitoringTaskCheck$listMonitors(monitorId, naked, )

$getMonitoringTask() Retrieve a specific monitor.

Usage

1 2	monitors$getMonitoringTask$listMonitors(monitorId, naked, search, ) monitors$getMonitoringTask$listMonitors(search=list("foo"="bar"))

$getMonitoringTaskCheck() Retrieve a specific monitor check

Usage

1 2	monitors$getMonitoringTaskCheck$listMonitors(monitorId, checkId, naked, search, ) monitors$getMonitoringTaskCheck$listMonitors(search=list("foo"="bar"))

$listMonitoringTaskChecks() Retrieve checks for a specific monitor

Usage

1 2	monitors$listMonitoringTaskChecks$listMonitors(monitorId, naked, startDate, endDate, result, limit, offset, search, ) monitors$listMonitoringTaskChecks$listMonitors(search=list("foo"="bar"))

$listMonitoringTasks() Retrieve Monitor for a specific resource.

Usage

1 2	monitors$listMonitoringTasks$listMonitors(naked, target, active, limit, offset, search, ) monitors$listMonitoringTasks$listMonitors(search=list("foo"="bar"))