url_response AC Configuration

This article is for probe versions 4.3 or later.
uimpga-ga
url_response_AC
This article describes the configuration concepts and procedures to set up the URL Endpoint Response Monitoring (url_response) probe. You can create a profile and set up the monitoring parameters, which when breached generates alarms and QoS messages.
This article is for probe versions 4.3 or later.
The following diagram outlines the process to configure the url_response probe:
url_response_AC_Configuration
url_response_AC_Configuration
Contents
Verify Prerequisites
Verify that required hardware and software is available before you configure the probe. For more information, see url_response (URL Endpoint Response Monitoring) Release Notes.
Configure General Properties
You can configure the general settings of the probe. These settings become applicable to all monitoring profiles of the probe.
Follow these steps:
  1. Open the
    url_response
    node.
    The
    Probe Information
    section provides information about the probe name, probe version, start time of the probe, and the probe vendor.
  2. Under the
    General Configuration
    section, update the following field information to configure the log properties of the probe. You can also configure the server monitoring properties of the probe.
    • Log Level:
      specifies the level of details that are written to the log file.
      Default: 0 - Fatal
      Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging.
    • Logfile Size (KB):
      specifies the size of the probe log file to which the internal log messages of the probe are written. When this size is reached, new log file entries are added and the older entries are deleted.
      Default: 100
    • Send Alarm on Each Sample:
      generates an alarm for each sample.
      Default: Selected
    • User Agent:
      specifies a user-agent string, which identifies your browser and provides certain system details to the server.
      Default: NimBUS/2.0
    • System Encoding
      :  specifies the encoding of the system where the probe is installed.Default: Blank
      : The probe auto-detects the system and output encoding when these field values are blank. However, CA recommends specifying the appropriate encoding in System Encoding fields. You can use UTF-8, Shift_JIS, ISO-2022-JP, ISO-2022-CN, ISO-2022-KR, GB18030, GB2312, Big5, EUC-JP, EUC-KR, ISO-8859-1, ISO-8859-2, windows-1250, and windows-1252 encodings.
    • Output Encoding
      : specifies the character encoding to generate alarms and QoS messages when the probe is deployed in a non-English locale. CA recommends using same encoding as that of the monitored system, unless explicitly stated to use a different one. Default: Blank
    • No URL Resolve
      : If checked, the monitored URL is not resolved. For example,
      https://docs.microsoft.com/en-us/
      will not be resolved to
      e13630.dscb.akamaiedge.net
      Default: Blank
  3. Click
    Save
    .
Create a Profile
You can create a profile and define the monitoring parameters.
Follow these steps:
  1. Click the
    Options (icon)
    next to the
    url_response
    node in the navigation pane.
  2. Click
    New Profile
    .
  3. Complete the following field information in the
    New Profile
    window.
    • Active:
      allows you to activate the monitoring, on profile creation.
    • Profile Name:
      specifies a unique name for the profile.
    • URL:
      defines the URL of the web page you want to monitor.
    • (From url_response 4.41) Additional Header:
      specifies the comma separated URL header key-value pairs in the
      Key: Value
      format. For example, x-api-key1: 8DB54440-B550, x-api-key2: 8DB54440-B551, and so on.
    • Virtual Hostname:
      defines the virtual host and IP address of the system hosting the URL that you want to monitor.
      The robot name is displayed in alarms for $host by default, if virtual hostname is blank.
    • Check Interval (Seconds):
      defines the time interval between each request of accessing the URL.
      Default: 300 seconds
    • Timeout (Seconds):
      defines the time interval for which the probe waits to load the complete web page.
      Default: 30 seconds
    • Retries Before Failure:
      defines the number of attempts for accessing the URL. If URL is not accessible in these attempts, the probe generates a failure message. For example, if the
      Check Interval
      is set to 300 seconds and retry is set to 3 then the probe executes all the 3 retries in 300 seconds and generates an alarm, on failure.
      Default: 3
    • Ignore Connection Time:
      excludes the connection time for calculating the total response time of the URL.
    • System Encoding
      : specifies the system encoding where the probe is installed.
      Default: Blank
    • Output Encoding
      : specifies the character encoding to generate alarms and QoS messages when the probe is deployed in a non-English locale.Default: Blank
    • Page Content Encoding
      : specifies the page content encoding for the regular expressions. The page content encoding of any url should be set as charset of any url page.Default: Blank
    • Url Folder Path Encoding
      : specifies the url folder path encoding. Default: UTF-8
      : If you create the folder path manually in non-ASCII characters on any server such as IIS, and if its encoding is other than UTF-8, then provide that value in the
      Url Folder Path Encoding
      field.
       
  4. Click
    Submit.
    The profile is created as Profile-
    profile name
    node, which when selected shows the profile name and the URL to be monitored.
  5. Navigate to the
    profile name
    node.
  6. Under the
    General Properties
    section, update the following information to configure the basic properties of the monitoring profile, such as the profile name and URL:
    • Alarm Source Override:
      defines the new source for alarms that the profile generates. If the field is left blank, the probe uses the robotname as the source.
    • QOS Source Override:
      defines the new source for QOS which is defined in profile. If the field is left blank, the probe uses the hostname as the source.
    • Average Over:
      allows you to calculate average value for comparing it with the threshold value.
      Default: Not Selected
    • Sample Value:
      defines the number of samples for calculating the average.
      Default: 5
      : You must specify a value greater than one for Sample Value. If the probe finds this field value as zero, it takes five as the default value.
    • Activate Alarms:
      allows you to generate alarms for the profile.Default: Selected
      On Unified Service Management (USM), the alarms display under a Device ID created by the probe, which is the destination URL without the port number.
    • System Encoding
      : specifies the system encoding where the probe is installed.
      Default: Blank
    • Output Encoding
      : specifies the character encoding to generate alarms and QoS messages when the probe is deployed in a non-English locale.Default: Blank
    • Page Content Encoding
      : specifies the page content encoding for the regular expressions.Default: Blank
  7. Click
    Actions > Test URL
    to check if the specified URL is valid and can be monitored.
    If an error message is displayed on the test URL, then, that message is displayed in English for non-English locales.
  8. Under the
    SSL Settings
    section, update the following field information to enable the SSL certificate verification and provides the certification bundle path:
    • Use SSL:
      enables or disables the SSL certificate verification.
      Default: Not selected
    • Peer Verification:
      enables or disables the peer verification for validating the SSL connection.
    • Certificate Authority Bundle Path:
      defines the certification bundle path for the SSL verification.
    • Host Verification:
      enables or disables the host verification for validating the SSL connection.
    • Host Verification Level:
      defines host verification level.
      • Loose
        : defines the level where the host name that is entered in the Server address field is not verified against the Common Name (CN) attribute appearing in the SSL certificate. The verification checks if the IP address/host name points to the same server.
      • Strict
        : defines the level where the host name that is entered in the Server address field is verified against the CN attribute appearing in the SSL certificate. If the host name does not match with the CN field, the session request gets rejected.
  9. Under the
    User Authentication
    section configure the
    User
    name and
    Password
    of a particular user. These user details are used when the web server (hosting the URL) requires the respective user to log in.
  10. Under the
    Authentication
    section, choose one of the following authentication types for the user to log in to the server:
    • Windows NT Authentication:
      allows you to enable the Windows Integrated Authentication. The proxy settings are then fetched from the registry, as saved by Internet Explorer. If you select this option, the probe supports monitoring of only the following metrics:
      • Response time
      • Fetch time in bytes per second
      • Fetch size in bytes
      • Substring found
      When the probe is hosted on the Linux environment, you can select the Authentication type from the drop-down list.
    • Proxy Properties:
      allows you to define the proxy properties explicitly for the probe.
      • Host
        : defines the name of the host that forwards your URL requests.
      • Port
        : defines the Proxy http-port.
      • User
        : defines username to log in the proxy hosts.
      • Password
        : defines the password corresponding to the proxy login user.
      • Authentication Type:
        specifies the type of authentication required for accessing the URL via proxy server.
        • Basic:
          specifies a basic HTTP authentication that allows you to define a username and password for accessing the URL. The Basic authentication used in HTTP is based on plain text.
        • NTLM:
          specifies if NT LAN Manager (NTLM) security protocol is required to access the URL in a Windows network. NTLM uses three messages to authenticate a client in a connection-oriented or connection-less environment. First, the client establishes a network connection to the server and sends a NEGOTIATE_MESSAGE to advertise its attributes. Next, the server responds with CHALLENGE_MESSAGE that should be used to establish the identity of the client. Finally, the client responds to the challenge with an AUTHENTICATE_MESSAGE. If the integrity is desired, a fourth additional message is sent.
        • DIGEST:
          specifies if DIGEST authentication method is used to access the URL. This method uses a client and server to exchange credentials over HTTP. The password is combined with other bits of information to create an MD5 hash, which is then sent to the server to authenticate.
        • GSSNEGOTIATE:
          specifies if GSSNEGOTIATE authentication is used for accessing the URL. The authentication is used when a client application wants to authenticate to a remote server, but neither end is sure of authentication protocols the other supports.
        • ANYSAFE:
          specifies if ANYSAFE authentication is used for accessing the URL.
  11. Under
    SSL Certification
    section, update the following field information to configure the SSL certificates. These details allow handling of the SSL errors and raising alarms. The alarms are related to the expiration dates of server certificates of the URL.
    • Ignore SSL errors:
      allows you to ignore the SSL errors that occur while accessing the URL.
      Default: Not selected
    • Server Certificate within:
      raises an alarm if the server certificate is due to expire within the specified number of days. Selecting this option enables the
      Days of expiration
      field.
      Default: Not selected
    • Days of Expiration:
      defines the number of days when the alarm is raised.
    • Certificate Expired:
      raises an alarm when the SSL certificate is already expired at the time of accessing the URL.
      Default: Not selected
    • Configure SSL Certificate:
      allows you to configure the SSL certificate in the system.
      Default: Not selected
    • Client Certificate:
      defines the path of the client certificate. You can use the
      Browse
      option for locating the path.
    • Client Private Key:
      defines the path of the client private key file. You can use the
      Browse
      option for locating the path.
    • Certificate Password:
      defines the password of the certificate.
  • If you do not want to use a profile, click
    Options (icon)
    beside the Profile-
    profile name
    node and select
    Delete Profile.
  • The probe does not support non-ASCII username and password.
Configure Alarms and QoS Messages
You can configure the QoS messages that the profile can generate when specified threshold is breached.
Follow these steps:
  1. Navigate to
    url_response > Profile-
    profile name >
    url >
    profile name >
    Metric
    node.
  2. Under the
    Page Load Time
    section, update the following information to monitor the loading time of the web page:
    • Publish Data:
      allows you to generate QoS.
    • Max Page Load Time (Milliseconds):
      defines the maximum load time in milliseconds for raising an alarm when actual load time exceeds the limit.
      Default: 8000 milliseconds
    • Page Load Exceeds Time Limit Message:
      specifies the alarm message to be issued when the page load time exceeds the specified maximum time limit.
    • Minimum Page Load Time (Milliseconds):
      specifies the minimum load time of the web page in milliseconds.
    • Page Load below Minimum Time Limit Message:
      specifies the alarm message to be issued when the page load time is less than the specified minimum time limit.
    • Page load failed Message:
      specifies the alarm message to be sent when the page is not loaded.
  3. Under the
    Time to First Byte
    section, update the following information to monitor the loading time of the first byte of the web page:
    • Publish Data:
      allows you to generate QoS.
    • Time to First Byte (Milliseconds):
      specifies the time limit for loading the first byte of the web page.
    • First byte fetch Time Limit Message:
      specifies an alarm message to be issued when the page fails to load the first byte within the specified time limit.
  4. Under the
    Time to Last Byte
    section, update the following information to monitor the loading time of the last byte of the web page:
    • Publish Data:
      allows you to generate QoS.
    • Time to Last Byte (Milliseconds):
      defines the time limit for loading the last byte of the web page.
    • Last byte fetch Time limit Message:
      specifies an alarm message to be issued when the page fails to load the last byte within the specified time limit.
  5. Under the
    TCP Connect Time
    section, update the following information to monitor the TCP connect time of the web page:
    • Publish Data:
      allows you to generate QoS.
    • TCP Connect Time (Milliseconds):
      specifies the time that is required to establish a TCP connection.
    • TCP Connect Time Limit Message:
      specifies an alarm message to be issued when the TCP connection is not established within the specified time limit.
  6. Under the
    SubString Found
    section, update the following information to find a string in the web page content. You can also configure the regular expressions for filtering the web page content.
    • Publish Data:
      allows you to generate QoS.
    • Look for Substring in Page Content:
      defines a string for searching in the web page content, once it is loaded. The page content encoding of any url should be set as charset of any url page in the
      Page Content Encoding
      field in the General Properties section.
    • Use regexp content matching:
      defines a regular expression while matching instead of a definite substring. Select the
      Use regexp content
      matching
      option if you use regular expressions in the string and start and end the string with a "/".
    • Dump File Content on File Content Alarm Condition:
      dumps the contents of the page to a file, which the profile is monitoring.
    • Alarm Properties:
      specifies the condition when to generate the alarm. You can select from the following options:
      • No Alarm
      • Found
      • Not Found
    • Retry page fetch on Alarm condition:
      configures the retry attempts for loading the web page, when an error occurs.
    • No. of Retries:
      specifies the number of times the probe tries to load the page before issuing an alarm.
    • Retry Timeout (Seconds):
      specifies the time limit for loading the web page in a retry attempt.
    • Page does not contain expected text message:
      specifies the alarm message to be issued when the web page does not contain the specified text.
    • Page contains text which should not be there Message:
      specifies an alarm message to be issued when the web page contains the specified text.
    • Page load failed Message:
      specifies the alarm message to be issued when the web page does not load.
    • Profile Execution Delay Message:
      specifies an alarm message to be issued when there is a delay in the profile execution.
  7. Under the
    Fetched Bytes Per Sec
    section, select
    Publish Data
    to monitor the bytes fetched by the probe for loading the web page and generate the QoS message.
  8. Under the
    DNS Resolution Time
    section, update the following information to monitor the time for resolving the DNS where the web page is hosted:
    • Publish Data:
      allows you to generate QoS.
    • DNS Resolution Time (Milliseconds):
      defines the threshold time for the DNS resolution.
    • DNS Resolution time Limit Message:
      specifies the alarm message to be issued when the DNS resolution time exceeds the threshold limit.
  9. Under the
    Download Time
    section, update the following information to monitor the download time of the URL:
    • Publish Data:
      allows you to generate QoS.
    • Download time (Milliseconds):
      defines the threshold time for web content downloading.
    • Download Time limit Message:
      specifies the alarm message to be issued when the download time exceeds the threshold limit.
  10. Under the
    Redirect Time
    section, update the following information to monitor the redirect time to another linked URL:
    • Publish Data:
      allows you to generate QoS.
    • Redirect Time (Milliseconds):
      defines the threshold time for the web page redirection.
    • Redirect time limit Message:
      specifies the alarm message to be issued when the web page redirection time exceeds the threshold limit.
  11. Under the
    Fetch Bytes
    section, update the following information to monitor the number of bytes fetched per second by the probe:
    • Publish Data:
      allows you to generate QoS.
    • Threshold Fetch:
      allows you to configure the threshold for the number of bytes fetched per second.
      Default: Not selected
    • Threshold Fetch Bytes:
      defines a threshold for the number of bytes fetched per second.
    • Fetched Bytes Below Threshold Message:
      specifies an alarm message to be issued when the number of bytes fetched is less than the specified value.
  12. Select
    Publish  Alarms
    for the following sections, as required:
    • HTTP Error:
      generate alarms when an HTTP error occurs while accessing the URL.
    • Config Error:
      generate alarm when a configuration error occurs while accessing the URL.
    • Delayed:
      generate alarm when the response time of the URL is delayed.
    • Certificate Expired:
      generate alarm when the SSL certificate of the URL is expired.
    • Certificate due to Expire:
      generate alarm when the SSL certificate of the URL is about to expire within the specified days.
    • Alarm Overrides:
      override the alarm messages that are configured in all the sections of the metric node (for example, the Certificate Expired, Configuration Error and HTTP Error messages).
View Alarm Messages
You can view the alarm messages that are configured in the probe.
Follow these steps:
  1. Open the
    url_response
    node.
  2. Under the
    Messages
    section, view the following field information about each alarm message:
    • Name:
      displays the unique name for the alarm message. This name is used to refer to the message from the profiles.
    • Text
      : displays the error message text.
    • Level:
      indicates the alarm which is raised.
    • Subsystem
      : displays the subsystem ID of the alarm message.
    • Default For
      : displays the default value of the message.
    • Variables
      : displays the variable names that are used in the alarm message text.
    • i18N Token
      : identifies the predefined alarms.
      : For
      Failed
      alarm message, the value of $desciption variable is displayed in English only for non-English locales.