manual:web_monitoring

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:web_monitoring [2019/06/13 06:01]
martins-v linking to Kerberos auth example
manual:web_monitoring [2020/09/14 14:21] (current)
martins-v adding digest authentication (ZBXNEXT-4647)
Line 47: Line 47:
  
 All mandatory input fields are marked with a red asterisk. ​ All mandatory input fields are marked with a red asterisk. ​
 +
 +<​note>​ User macros are supported in many web scenario parameters, but secret macros should not be used in URLs as they will resolve as <​nowiki>​ "​******"​ </​nowiki>​.</​note>​
  
 Scenario parameters: Scenario parameters:
Line 55: Line 57:
 |//​Application// ​ |Select an application the scenario will belong to.\\ Web scenario items will be grouped under the selected application in //​Monitoring -> Latest data//​. ​ | |//​Application// ​ |Select an application the scenario will belong to.\\ Web scenario items will be grouped under the selected application in //​Monitoring -> Latest data//​. ​ |
 |//New application// ​ |Enter the name of a new application for the scenario. ​ | |//New application// ​ |Enter the name of a new application for the scenario. ​ |
-|//Update interval// ​ |How often the scenario will be executed.\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 30s, 1m, 2h, 1d, since Zabbix 3.4.0.\\ [[:manual/config/macros/usermacros|User macros]] are supported, since Zabbix 3.4.0.\\ //Note// that if a user macro is used and its value is changed (e.g. 5m -> 30s), the next check will be executed according to the previous value (farther in the future with the example values). ​ |+|//Update interval// ​ |How often the scenario will be executed.\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 30s, 1m, 2h, 1d, since Zabbix 3.4.0.\\ [[manual:config:macros:​user_macros|User macros]] are supported, since Zabbix 3.4.0.\\ //Note// that if a user macro is used and its value is changed (e.g. 5m -> 30s), the next check will be executed according to the previous value (farther in the future with the example values). ​ |
 |//​Attempts// ​ |The number of attempts for executing web scenario steps. In case of network problems (timeout, no connectivity,​ etc) Zabbix can repeat executing a step several times. The figure set will equally affect each step of the scenario. Up to 10 attempts can be specified, default value is 1.\\ //Note//: Zabbix will not repeat a step because of a wrong response code or the mismatch of a required string.\\ This parameter is supported starting with //Zabbix 2.2//​. ​ | |//​Attempts// ​ |The number of attempts for executing web scenario steps. In case of network problems (timeout, no connectivity,​ etc) Zabbix can repeat executing a step several times. The figure set will equally affect each step of the scenario. Up to 10 attempts can be specified, default value is 1.\\ //Note//: Zabbix will not repeat a step because of a wrong response code or the mismatch of a required string.\\ This parameter is supported starting with //Zabbix 2.2//​. ​ |
 |//​Agent// ​ |Select a client agent.\\ Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.\\ User macros can be used in this field, //starting with Zabbix 2.2//​. ​ | |//​Agent// ​ |Select a client agent.\\ Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.\\ User macros can be used in this field, //starting with Zabbix 2.2//​. ​ |
Line 76: Line 78:
 The **Steps** tab allows you to configure the web scenario steps. To add a web scenario step, click on //Add// in the //Steps// block. The **Steps** tab allows you to configure the web scenario steps. To add a web scenario step, click on //Add// in the //Steps// block.
  
-{{manual:​config:​scenario2.png?600|}}+{{manual:​config:​scenario_b.png?600|}}
  
 === Configuring steps === === Configuring steps ===
Line 93: Line 95:
 |//Follow redirects// ​ |Mark the checkbox to follow HTTP redirects.\\ This sets the [[http://​curl.haxx.se/​libcurl/​c/​CURLOPT_FOLLOWLOCATION.html|CURLOPT_FOLLOWLOCATION]] cURL option.\\ This option is supported //starting with Zabbix 2.4//​. ​ | |//Follow redirects// ​ |Mark the checkbox to follow HTTP redirects.\\ This sets the [[http://​curl.haxx.se/​libcurl/​c/​CURLOPT_FOLLOWLOCATION.html|CURLOPT_FOLLOWLOCATION]] cURL option.\\ This option is supported //starting with Zabbix 2.4//​. ​ |
 |//Retrieve mode// ​ |Select the retrieve mode:\\ **Body** - retrieve only body from the HTTP response\\ **Headers** - retrieve only headers from the HTTP response\\ **Body and headers** - retrieve body and headers from the HTTP response\\ This option is supported //since Zabbix 4.2//​. ​ | |//Retrieve mode// ​ |Select the retrieve mode:\\ **Body** - retrieve only body from the HTTP response\\ **Headers** - retrieve only headers from the HTTP response\\ **Body and headers** - retrieve body and headers from the HTTP response\\ This option is supported //since Zabbix 4.2//​. ​ |
-|//​Timeout// ​ |Zabbix will not spend more than the set amount of time on processing the URL (maximum ​is 1 hour). Actually this parameter defines the maximum time for making connection to the URL and maximum time for performing an HTTP request. Therefore, Zabbix will not spend more than **2 x Timeout** seconds on the step.\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 30s, 1m, 1h. [[:manual/config/macros/usermacros|User macros]] are supported. ​ |+|//​Timeout// ​ |Zabbix will not spend more than the set amount of time on processing the URL (from one second to maximum ​of 1 hour). Actually this parameter defines the maximum time for making connection to the URL and maximum time for performing an HTTP request. Therefore, Zabbix will not spend more than **2 x Timeout** seconds on the step.\\ [[:​manual/​appendix/​suffixes|Time suffixes]] are supported, e.g. 30s, 1m, 1h. [[manual:config:macros:​user_macros|User macros]] are supported. ​ |
 |//Required string// ​ |Required regular expression pattern.\\ Unless retrieved content (HTML) matches the required pattern the step will fail. If empty, no check on required string is performed.\\ For example:\\ Homepage of Zabbix\\ Welcome.*admin\\ //Note//: Referencing [[regular_expressions|regular expressions]] created in the Zabbix frontend is not supported in this field.\\ User macros and {HOST.*} [[:​manual/​appendix/​macros/​supported_by_location|macros]] are supported, since Zabbix 2.2. | |//Required string// ​ |Required regular expression pattern.\\ Unless retrieved content (HTML) matches the required pattern the step will fail. If empty, no check on required string is performed.\\ For example:\\ Homepage of Zabbix\\ Welcome.*admin\\ //Note//: Referencing [[regular_expressions|regular expressions]] created in the Zabbix frontend is not supported in this field.\\ User macros and {HOST.*} [[:​manual/​appendix/​macros/​supported_by_location|macros]] are supported, since Zabbix 2.2. |
 |//Required status codes// ​ |List of expected HTTP status codes. If Zabbix gets a code which is not in the list, the step will fail.\\ If empty, no check on status codes is performed.\\ For example: 200,​201,​210-299\\ User macros are supported since Zabbix 2.2.  | |//Required status codes// ​ |List of expected HTTP status codes. If Zabbix gets a code which is not in the list, the step will fail.\\ If empty, no check on status codes is performed.\\ For example: 200,​201,​210-299\\ User macros are supported since Zabbix 2.2.  |
Line 102: Line 104:
 === Configuring authentication === === Configuring authentication ===
  
-The **Authentication** tab allows you to configure scenario authentication options.+The **Authentication** tab allows you to configure scenario authentication options. A green dot next to the tab name indicates that some type of HTTP authentication is enabled.
  
 {{manual:​config:​scenario3.png|}} {{manual:​config:​scenario3.png|}}
Line 109: Line 111:
  
 ^Parameter^Description^ ^Parameter^Description^
-|//​Authentication// ​ |Authentication options.\\ ​ **None** - no authentication used.\\ **Basic** - basic authentication is used.\\ **NTLM** - NTLM ([[http://​en.wikipedia.org/​wiki/​NTLM|Windows NT LAN Manager)]] authentication is used.\\ **Kerberos** - Kerberos authentication is used. See also: [[:​manual/​appendix/​items/​kerberos|Configuring Kerberos with Zabbix]].\\ Selecting an authentication method will provide two additional fields for entering a user name and password.\\ User macros can be used in user and password fields, //starting with Zabbix 2.2//​. ​ |+|//​Authentication// ​ |Authentication options.\\ ​ **None** - no authentication used.\\ **Basic** - basic authentication is used.\\ **NTLM** - NTLM ([[http://​en.wikipedia.org/​wiki/​NTLM|Windows NT LAN Manager)]] authentication is used.\\ **Kerberos** - Kerberos authentication is used. See also: [[:​manual/​appendix/​items/​kerberos|Configuring Kerberos with Zabbix]].\\ **Digest** - Digest authentication is used.\\ Selecting an authentication method will provide two additional fields for entering a user name and password.\\ User macros can be used in user and password fields, //starting with Zabbix 2.2//​. ​ |
 |//SSL verify peer// ​ |Mark the checkbox to verify the SSL certificate of the web server.\\ The server certificate will be automatically taken from system-wide certificate authority (CA) location. You can override the location of CA files using Zabbix server or proxy configuration parameter [[manual:​appendix:​config:​zabbix_server|SSLCALocation]].\\ This sets the [[http://​curl.haxx.se/​libcurl/​c/​CURLOPT_SSL_VERIFYPEER.html|CURLOPT_SSL_VERIFYPEER]] cURL option.\\ This option is supported //starting with Zabbix 2.4//​. ​ | |//SSL verify peer// ​ |Mark the checkbox to verify the SSL certificate of the web server.\\ The server certificate will be automatically taken from system-wide certificate authority (CA) location. You can override the location of CA files using Zabbix server or proxy configuration parameter [[manual:​appendix:​config:​zabbix_server|SSLCALocation]].\\ This sets the [[http://​curl.haxx.se/​libcurl/​c/​CURLOPT_SSL_VERIFYPEER.html|CURLOPT_SSL_VERIFYPEER]] cURL option.\\ This option is supported //starting with Zabbix 2.4//​. ​ |
 |//SSL verify host// ​ |Mark the checkbox to verify that the //Common Name// field or the //Subject Alternate Name// field of the web server certificate matches.\\ This sets the [[http://​curl.haxx.se/​libcurl/​c/​CURLOPT_SSL_VERIFYHOST.html|CURLOPT_SSL_VERIFYHOST]] cURL option.\\ This option is supported //starting with Zabbix 2.4//​. ​ | |//SSL verify host// ​ |Mark the checkbox to verify that the //Common Name// field or the //Subject Alternate Name// field of the web server certificate matches.\\ This sets the [[http://​curl.haxx.se/​libcurl/​c/​CURLOPT_SSL_VERIFYHOST.html|CURLOPT_SSL_VERIFYHOST]] cURL option.\\ This option is supported //starting with Zabbix 2.4//​. ​ |
Line 134: Line 136:
 </​code>​ </​code>​
 </​note>​ </​note>​
 +
 === Display === === Display ===
  
-To view detailed data of defined ​web scenarios, go to //​Monitoring -> Web// or //Latest data//. Click on the scenario name to see more detailed ​statistics.+To view web scenarios ​configured for a host, go to //​Monitoring -> Hosts//, locate the host in the list and click on the //Web// hyperlink in the last column. Click on the scenario name to get detailed ​information. 
 + 
 +{{manual:​web_monitoring:​scenario_details2.png?​600|}} 
 + 
 +An overview of web scenarios can also be displayed in //​Monitoring -> Dashboard// by a Web monitoring widget
  
-{{manual:​web_monitoring:​scenario_details1.png?600|}}+Recent results of the web scenario execution are available in the //​Monitoring -> Latest data// section
  
-An overview of web monitoring scenarios can be viewed in //​Monitoring -> Dashboard//​. 
  
 === Extended monitoring === === Extended monitoring ===