Overview Package Class Deprecated Help

sup
SupervisionManager

Manager for supervision groups / summary view components.

public class SupervisionManager

Properties
kpiHistoryDuration Retained KPI state history duration in hours.

type=int
default=2
minimum=1
maximum=2
Displayed(tab/group)=KPI History Duration (hours)
persistStateHistory IFF true, supervision groups history is persisted in the DB.

type=boolean
default=true
refreshPeriod Number of hours between sanity refreshing all monitored groups to make sure their KPIs are accurate. "0" means "don't ever run refresh tasks"

type=int
default=0
minimum=0
maximum=720
snapshotPeriod Number of minutes between taking a snapshot of the supervision state.

type=int
default=5
minimum=5
maximum=60
Displayed(tab/group)=KPI History Interval (minutes)
sup.SummaryView-Set type=Children-Set
sup.SupervisionGroup-Set type=Children-Set
upgradeFlags Specifies which of the complex upgrade features have already been run. Complex upgrades are the upgrades that are hard to run via scripts because retrieving necessary data might not be possible. Instead, the specific upgrade is performed only once during the initialization and never again after setting the corresponding feature upgrade flag.

type=sup.SupUpgradeFlags
access=read-only
default=0
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

clearAllHistory

This method clears the history of all monitored groups.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

dumpLog

Writes details of the cache contents into the system log.
Input Parameters:
logLevel : int - Logging level.
details : int - Details level. 0: very brief info, 1: more details, 2: most details
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
dump : string - Cache contents info.

getGroupsByFdn

This method returns a list of supervision group/view fdns based on the monitored fdn.
Input Parameters:
className : string - The class name for the search.
monitoredFdn : string - Monitored object fdn.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Map (string to List (string)) - list of supervision group fdn.

getGroupsByFdnForUser

This method returns a supervision group/view fdns based on the monitored fdn and the user's access rights. At this moment, this method will be called only by service supervision to enable access control. When the user searches a service or group on the search bar, this method will be called and we will search that service/supervision group and return its supervision group and summary view (first match)
Input Parameters:
className : string - The class name for the search.
monitoredFdn : string - Monitored object fdn.
user : string - The user name
appType : int - application type
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : Map (string to string) - Map of (supervision group, summary view)

keepAliveUpdate

This method refreshes the last access time of a given sup client (ping).
Input Parameters:
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
keepAlivePeriodMillis : long - Period to which the SAM-S client must ping the server.

rebuildCache

This method completely clears supervision cache and then rebuilds it.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

searchMonitoredObject

This method returns list of supervision info for a monitored objects being searched for a given criteria.
Input Parameters:
className : string - The class name for the search.
filter : FilterHolder - criteria to match the search against.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string -

setBaseline

This method sets baseline (current moment in time) for all future monitored "*New*" KPI events - e.g. new alarms raised, new tests failures etc..
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
baselineTime : Date - The time of setting the baseline.

takeSnapshot

This method takes/saves a snapshot of all monitored groups states.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
snapshotTime : long - Time the snapshot was taken at.