Submit a ticketCall us

Announcing NCM 7.7
With NCM 7.7, you can examine the rules that make up an access control list for a Cisco ASA device. Then you can apply filters to display only rules that meet the specified criteria, order the rules by line number or by the hit count, and much more.
See new features and improvements.

Home > Success Center > Server & Application Monitor (SAM) > SAM 6.4 Administrator Guide > Create and manage alerts for SAM > Alert variables for SAM

Alert variables for SAM

SAM supplements the alerting abilities of the Orion Platform with a number of SAM-specific configurable alerts and variables.

Component Monitor properties for alerts

The following alert possibilities for component monitors.

Component Name

This allows you to base your alert criteria on component names.

Component Type

This allows you to base your alert criteria on component types. Specify the component monitor type by value using the following table.

Component Monitor Type Value
None 0
DHCP User Experience Monitor 35
Directory Size Monitor 38
DNS Monitor - TCP 4
DNS Monitor - UDP 5
DNS User Experience Monitor 15
Download Speed Monitor 25
File Age Monitor 36
File Change Monitor 23
File Count Monitor 39
File Existence Monitor 28
File Size Monitor 22
FTP Monitor 7
FTP User Experience Monitor 24
HTTP Form Login Monitor 27
HTTP Monitor 6
HTTPS Monitor 14
IMAP4 Monitor 13
IMAP4 User Experience Monitor 30
JMX Monitor 49
LDAP User Experience Monitor 34
Linux/Unix Script Monitor 21
MAPI User Experience Monitor 31
Nagios Script Monitor 50
NNTP Monitor 11
ODBC User Experience Monitor 16
Oracle User Experience Monitor 18
Performance Counter Monitor 37
POP3 Monitor 12
POP3 User Experience Monitor 29
Process Monitor – SNMP 8
Process Monitor - WMI 1
RADIUS User Experience Monitor 40
SMTP Monitor 10
SNMP Monitor 32
SQL User Experience Monitor 17
TACACS+ User Experience Monitor 41
TCP Port Monitor 2
Tomcat Server Monitor 33
Web Link Monitor 26
Windows Event Monitor 42
Windows PowerShell Monitor 45
Windows Script Monitor 20
Windows Service Monitor 9
WMI Monitor 19

Component Status

This allows you to alert on Critical, Down, Unknown, Up, and Warning status.

Response Time

This allows you to alert on response time.

Statistic Data

This allows you to alert on statistic data.

Process (Service) Name

This allows you to alert on the process or service name. For example: dns.exe, or AlertingEngine.

Process Instance Count

This allows you to alert on the instance count of a process.

Percent CPU

This allows you to alert on the percentage of CPU in use of a monitored process or service.

Percent Physical Memory

This allows you to alert on the percentage of physical memory in use of a monitored process or service.

Percent Memory Used

This allows you to alert on the percentage of total memory in use of a monitored process or service.

Percent Virtual Memory

This allows you to alert on the percentage of virtual memory in use of a monitored process or service.

Virtual Memory Used

This allows you to alert on the amount of virtual memory in use, in bytes, of a monitored process or service.

Component Monitor variables for alerts

The following variables are available when selecting APM-Component as the property type.

Component Monitor Variable Macro Definition
${APM:ComponentDetailsURL} ${N=SwisEntity;M=DetailsUrl} Hyperlink to the Component Details page that triggered the alert.
${ApplicationId} ${N=SwisEntity;M=Application.ApplicationID} Provides the unique numeric identifier of the application. This value is analogous to the node ID.
${ApplicationName} ${N=SwisEntity;M=Application.ApplicationAlert.ApplicationName} Provides the name of the monitored application.
${ApplicationStatus} ${N=SwisEntity;M=Application.Status} Provides the status of the application.
${ComponentId} ${N=SwisEntity;M=ComponentAlert.ComponentID} Provides the numeric component ID of the specific application.
${ComponentMessage} ${N=SwisEntity;M=ComponentAlert.ComponentMessage} Message sent when alerting on component status.
${ComponentName} ${N=SwisEntity;M=ComponentAlert.ComponentName} Provides the name of the component, for example, SW Module Engine.
${ComponentStatus} ${N=SwisEntity;M=Status} Provides the status of the specific component.
${ComponentType} ${N=SwisEntity;M=ComponentAlert.ComponentType} Provides the numeric component type.
${DisplayType}

${N=SwisEntity;M=ComponentAlert.DisplayType}

Provides the display type for the specific monitor. For example, Windows Service.
${LastTimeUp}

${N=SwisEntity;M=ComponentAlert.LastTimeUp}

Provides the date and time the component was last seen in the Up state.
${MemoryUsed} ${N=SwisEntity;M=ComponentAlert.MemoryUsed} Provides the memory used by a component, in bytes.
${MultiValueMessages} ${N=SwisEntity;M=ComponentAlert.MultiValueMessages} Message sent when alerting on the Multiple Value Chart.
${MultiValueStatistics} ${N=SwisEntity;M=ComponentAlert.MultiValueStatistics} Statistics sent when alerting on the Multiple Value Chart.
${NodeID} ${N=SwisEntity;M=ComponentAlert.NodeId} Provides the numeric node ID of the server on which the application is monitored.
${PercentApplicationAvailability} ${N=SwisEntity;M=ComponentAlert.PercentApplicationAvailability} Provides the availability of an application as a percentage.
${PercentComponentAvailability} ${N=SwisEntity;M=ComponentAlert.PercentComponentAvailability} Provides the availability of a component as a percentage.
${PercentCPU} ${N=SwisEntity;M=ComponentAlert.PercentCPU} Provides the amount of CPU used by a component as a percentage.
${PercentMemory} ${N=SwisEntity;M=ComponentAlert.PercentMemory} Provides the memory used by a component as a percentage.
${PercentVirtualMemory} ${N=SwisEntity;M=ComponentAlert.PercentVirtualMemory} Provides the virtual memory used by a component as a percentage.
${ProcessInstanceCount} ${N=SwisEntity;M=ComponentAlert.ProcessInstanceCount} Provides the instance count of a process.
${ProcessName} ${N=SwisEntity;M=ComponentAlert.ProcessName} Provides the process name.
${ResponseTime} ${N=SwisEntity;M=ComponentAlert.ResponseTime} Provides the response time of a component.
${StatisticData} ${N=SwisEntity;M=ComponentAlert.StatisticData} Provides the statistics data value of a component.
${StatusOrErrorDescription] ${N=SwisEntity;M=ComponentAlert.StatusOrErrorDescription} Provides the status of the component, including the full text of any error messages.
${Threshold-CPU-Critical} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdCPUCritical} Provides the critical threshold for CPU.
${Threshold-CPU-Warning} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdCPUWarning} Provides the Warning threshold for the CPU.
${Threshold-PhysicalMemory-Critical} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdPhysicalMemoryCritical} Provides the Critical threshold for physical memory.
${Threshold-PhysicalMemory-Warning} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdPhysicalMemoryWarning} Provides the Warning threshold for physical memory.
${Threshold-ResponseTime-Critical} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdResponseTimeCritical} Provides the Critical threshold for response time.
${Threshold-ResponseTime-Warning} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdResponseTimeWarning} Provides the Warning threshold for response time.
${Threshold-Statistic-Critical} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdStatisticCritical} Provides the Critical threshold for statistics.
${Threshold-Statistic-Warning} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdStatisticWarning} Provides the Warning threshold for statistics.
${Threshold-VirtualMemory-Critical} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdVirtualMemoryCritical} Provides the Critical threshold for virtual memory.
${Threshold-VirtualMemory-Warning} ${N=SwisEntity;M=ComponentAlertThresholds.ThresholdVirtualMemoryWarning} Provides the Warning threshold for virtual memory.
${TimeStamp} ${N=SwisEntity;M=CurrentStatus.ObservationTimestamp} Provides the last polling date and time of a component.
${UserDescription} ${N=SwisEntity;M=ComponentAlert.UserDescription} Provides a description of the component. Note: A default description is given by SolarWinds. Any changes you make will override the default description and be automatically saved.
${UserNotes} ${N=SwisEntity;M=ComponentAlert.UserNotes} Provides notes from the user about a component. Changes you make will automatically be saved.
${WindowsEventMessages} ${N=SwisEntity;M=ComponentAlert.WindowsEventMessages} Full details of the corresponding event.
${VirtualMemoryUsed} ${N=SwisEntity;M=ComponentAlert.VirtualMemoryUsed} Provides the virtual memory used by a component, in bytes.

Application Monitor properties for alerts

You can use the following properties in alerts for application monitors.

Application Name

This allows you to select the names of currently configured application templates as values.

Application Status

This allows you to select whether the application is in a Critical, Down, Unknown, Up, or Warning status.

Application Monitor variables for alerts

The following variables are available when selecting APM-Application as the property type.

Application Variable Macro Definition
${APM:ApplicationDetailsURL} ${N=SwisEntity;M=DetailsUrl} Hyperlink to the Application Details page that triggered the alert, or the Details page of the application that triggered the component.
${Availability} ${N=SwisEntity;M=ApplicationAlert.ApplicationAvailability} Provides the status of the application.
${ComponentsWithProblems} ${N=SwisEntity;M=ApplicationAlert.ComponentsWithProblems} Provides a comma-delimited list of components in a Down, Unknown, Warning, or Critical state.
${ComponentsWithProblemsFormatted} ${N=SwisEntity;M=ApplicationAlert.ComponentsWithProblemsFormatted} List of components that are not Up along with the component status, formatted with HTML tags. HTML formatting is used for the Send e-mail action to provide an improved appearance of the listed components.
${ComponentsWithProblemsFormattedHtml} ${N=SwisEntity;M=ApplicationAlert.ComponentsWithProblemsFormattedHtml} List of components that are not Up along with the component status. Formatted with HTML tags for events that appear on the web console.
${ComponentsWithStatus} ${N=SwisEntity;M=ApplicationAlert.ComponentsWithStatus} Provides a comma-delimited list of all components and their current status.
${ComponentsWithStatusFormatted} ${N=SwisEntity;M=ApplicationAlert.ComponentsWithStatusFormatted} List of components with component status included formatted with html tags. Html formatting is used for send e-mail action to provide improved appearance of listed components.
${ComponentsWithStatusFormattedHtml} ${N=SwisEntity;M=ApplicationAlert.ComponentsWithStatusFormattedHtml} List of components with the component status. Formatted with HTML tags for events that appear in the web console.
${ID} ${N=SwisEntity;M=Application.ApplicationID} Provides the numeric application ID of the specific application.
${LastTimeUp} ${N=SwisEntity;M=CurrentStatus.LastTimeUp} Provides the date and time the application was last seen in an Up state.
${Name} ${N=SwisEntity;M=Application.ApplicationAlert.ApplicationName} Provides the name of the application that is triggering the alert.
${NodeID} ${N=SwisEntity;M=Application.Node.NodeID} Provides the numeric node ID of the server on which the application is monitored.
${SystemSummaryFormatted} ${N=SwisEntity;M=Application.ApplicationAlert.SystemSummaryFormatted} System summary. HTML formatting is used for the Send e-mail action to provide an improved appearance of the listed components.
${SystemSummaryFormattedHtml} ${N=SwisEntity;M=ApplicationAlert.SystemSummaryFormattedHtml} System summary. Formatted with HTML tags for events that appear in the web console.
${TimeStamp} ${N=SwisEntity;M=Application.CurrentStatus.ObservationTimestamp} Provides the last polling date and time of an application.
 
Last modified
07:06, 22 Mar 2017

Tags

Classifications

Public