Application Delivery Management

Alarms

December 31, 2023

Contributed by:

The alarms sub-section of the operations section has a similar structure and the same attributes as in the analytics sub-section. The only difference is in the properties attribute. For a list of all the attributes (other than the properties attribute), see Analytics.

The following properties are available in an alarms sub-section:

Attribute	Description	Mandatory
target	An expression that evaluates to the name of a virtual server, configured on the Citrix ADC, for which alarms are configured.	Yes
email-profile	Name of an email profile that is defined in the Citrix ADM Analytics feature and contains a list of email addresses that you want to notify when the alarm is triggered.	No (either an email-profile or an sms-profile must be defined)
sms-profile	Name of an SMS profile that is defined in the Citrix ADM Analytics feature and contains a list of phone numbers that you want to notify when the alarm is triggered.	No (either an email-profile or an sms-profile must be defined)
rules	A list of rules that define the conditions that would trigger an alarm for the virtual server defined by the target property.	Yes
metric	An attribute of rule. The name of a metric you want to track pertaining to the Citrix ADC virtual server.	Yes
operator	An attribute of rule. The operator to use to compare the metric to the value. Valid operators are “greaterthan” and “lessthan.”	Yes
value	An attribute of rule. The threshold value that the metric is compared to by using the operator. If the metric value exceeds this threshold, the associated alarms are triggered.	Yes
period-unit	An attribute of a rule. The frequency at which to alert users if the alarm rule is met. This can contain the value day, hour, or weekly. This means that if the rule is met, an alarm will be sent once a period-unit (for example, once a day).	Yes

The following table provides a list of metrics that are tracked pertaining to the Citrix ADC virtual server.

Counters	Description	Detailed Desription	Citrix ADM Calculation
	For a VPN virtual server
total_requests	Total VPN Session Launch Count	Total number of active sessions on this VPN virtual server started during a time interval specified by the user.	Monotonically increasing counter, incremented on each new session launch
	app_count	VPN App Launch Count	Total number of unique VPN applications on this VPN virtual server launched during a time interval specified by the user.	Monotonically increasing counter on each new application launch
	app_launch_duration	VPN App Launch Duration	Average time taken to launch an application (in milliseconds)	Average value calculated across the launch time durations of all VPN applications launched on this VPN virtual server
	Other virtual servers (CS, LB, Auth, GSLB)
	total_requests	Number of requests	Number of client requests on this virtual server since the last appliance reboot, or since the creation of the virtual server, whichever is more recent.	Monotonically increasing counter, incremented on each new request to this virtual server.
	total_bytes	Bytes	Total bytes transferred from the virtual server to Citrix ADM over the specified time interval.	Monotonically increasing counter to account for the total number of bytes served by this virtual server.
	application_response_time	Response Time	Average response time of the virtual server.	The average value of the response times of all requests received by this virtual server since the last reboot of the appliance (or since the creation of the virtual server), whichever is last.

Example of an alarms section in a StyleBook:

operations:
alarms:
 -
  name:lbvserver_alarm
  properties:
  target: $outputs.lbvserver
  email-profile: $parameters.emailprofile
  sms-profile: "NetScalerSMS"
     rules:
      -
        metric: "total_requests"
        operator: "greaterthan"
        value: 25
        period-unit: weekly
        -
          metric: "total_bytes"
          operator: "lessthan"
          value: 1024
          period-unit: day

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Alarms

December 31, 2023

Contributed by:

December 31, 2023

Contributed by:

Alarms

In this article