Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / Monitor.Sample
Private  Storage   

Monitor.Sample


Defines persistent monitor sample class

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5 7 2 1


Summary


Properties
%Concurrency Application DateTime GroupName InstanceKey
MetricsClass

Methods
%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %BuildIndicesSegment %BuildObjectGraph
%CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion %ClassName
%Close %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DowngradeConcurrency %ExecuteAfterTriggers %ExecuteBeforeTriggers
%Exists %ExistsId %Extends %FileIndices
%FileIndicesBuffered %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IncrementCount
%InsertBatch %IsA %IsModified %IsNull
%JournalObject %KillExtent %KillExtentData %LoadFromMemory
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %OnNew %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%SQLAcquireLock %SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers
%SQLBuildIndices %SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique
%SQLCheckUniqueIndices %SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol
%SQLCreateInsDelTables %SQLDefineiDjVars %SQLDelete %SQLDeleteChildren
%SQLDeleteTempStreams %SQLEExit %SQLExists %SQLFKeyDelLock
%SQLFastInsert %SQLFieldValidate %SQLGetLock %SQLGetOld
%SQLGetOldAll %SQLGetOldIndex %SQLInsert %SQLInsertComputes
%SQLInsertStreams %SQLInvalid %SQLInvalid2 %SQLMVDelete
%SQLMVIndexDelete %SQLMVIndexInsert %SQLMVIndexUpdate %SQLMVInsert
%SQLMVUpdate %SQLMissing %SQLNormalizeCompFields %SQLNormalizeFields
%SQLPurgeIndices %SQLQuickBulkInsert %SQLQuickBulkLoad %SQLQuickBulkSave
%SQLQuickBulkUpdate %SQLQuickDelete %SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID
%SQLQuickFindRowIDByPKey %SQLQuickInsert %SQLQuickLoad %SQLQuickLoadChildren
%SQLQuickLogicalToOdbc %SQLQuickOdbcToLogical %SQLQuickUpdate %SQLReleaseLock
%SQLReleaseTableLock %SQLStorageValidation %SQLTrigDelTab %SQLTrigInsTab
%SQLUnlock %SQLUnlock2 %SQLUnlockError %SQLUnlockRef
%SQLUpdate %SQLUpdateComputes %SQLUpdateStreams %SQLValidateCompFields
%SQLValidateFields %SQLicompView %SQLnBuild %Save
%SaveDirect %SaveIndices %SerializeObject %SetModified
%SortBegin %SortEnd %SyncObjectIn %SyncTransport
%UnlockExtent %UnlockId %UpgradeConcurrency %ValidateIndices
%ValidateObject ConvertParameter Decrypt Display
DisplayCSP DisplayDetails Encrypt EncryptBroker
EscapeHTML EscapeURL HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link NextKey
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RewriteURL SampleDataItem ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL

Subclasses
%Monitor.System.Sample.AuditCount %Monitor.System.Sample.AuditEvents %Monitor.System.Sample.CSPGateway
%Monitor.System.Sample.Clients %Monitor.System.Sample.Diskspace %Monitor.System.Sample.Freespace
%Monitor.System.Sample.Globals %Monitor.System.Sample.HistoryMemory %Monitor.System.Sample.HistoryPerf
%Monitor.System.Sample.HistorySys %Monitor.System.Sample.HistoryUser %Monitor.System.Sample.Journals
%Monitor.System.Sample.License %Monitor.System.Sample.LockTable %Monitor.System.Sample.Processes
%Monitor.System.Sample.Routines %Monitor.System.Sample.Servers %Monitor.System.Sample.SystemMetrics

Parameters


• parameter INDEX;
Table keys definition

Properties


• property Application as %String;
Application name for the sample
• property DateTime as %String;
Date and time of sample
• property GroupName as %String;
Group name for the sample
• property InstanceKey as %String(MAXLEN=500);
List of key values that identify a unique sample instance
• property MetricsClass as %String(MAXLEN=250);
Metrics Class for the sample

Methods


• method %OnNew(sample As Monitor.Sample, timestamp As %String) as %Status
Initialization method for sample data
• classmethod Display(mclass As %String) as %Status
• method DisplayCSP() as %Status
• method DisplayDetails() as %Status
Display details of sample data for this item
• classmethod NextKey(app As %String, group As %String, ByRef key As %List) as %Status
Next key value.
• classmethod OnPage() as %Status
CSP page display
• classmethod SampleDataItem(app As %String, group As %String, key As %List, ByRef id As %String) as %Status
Returns %ID for a sample data item NOTE: for a definition with no indexes (in Sample.InstanceKey) the 'key' value must be passed as $lb(" "). The %OnNew method above sets the space (" ") value in the InstanceKey, and the SQL query here won't find it if 'key' is passed as NULL. ^SNMP in particular uses this convention to get sample data with no secondary index.

Queries


• query InstanceKeys(app As %String, group As %String)
SQL Query :
SELECT InstanceKey FROM Sample
WHERE (Application = :app AND
GroupName = :group)
HAVING DateTime = MAX(DateTime)
Return the instance keys in their encoded format
• query LatestSample(class As %String)
SQL Query :
SELECT %ID FROM Sample
WHERE MetricsClass = :class
HAVING DateTime = MAX(DateTime)
Query to return all sample data id's for a particular application, group

Indices


•index (IdKey on Application,GroupName,InstanceKey) [IdKey];
Idkey index for samples