You can register the following ArcGIS Server services hosted on a remote ArcGIS Server site to collect service health and performance metrics:
- Feature
- Image
- Map
When ArcGIS Monitor Agent can be installed on the ArcGIS Server site machines, it is recommended that you register the site using the ArcGIS Server component. This allows you to collect attributes and metrics for the operating system, the ArcGIS Server site, and ArcGIS Server services.
Prerequisites for monitoring
The following prerequisites are necessary for monitoring remote ArcGIS Server services:
- ArcGIS Monitor Agent must be installed on a machine that has access to the services and must be registered with ArcGIS Monitor Server.
- The services must be hosted using one of the following versions of ArcGIS Server. The specific versions listed are the minimum certified versions. Newer minor versions are supported but are not certified unless otherwise stated.
- ArcGIS Server 10.9.1
- ArcGIS Server 11.0
- ArcGIS Server 11.1
- ArcGIS Server 11.3
- ArcGIS Server 11.4
- ArcGIS Server 11.5
- Secured services require ArcGIS Server token-based authentication. Other forms of authentication such as Integrated Windows Authentication (IWA) and Security Assertion Markup Language (SAML) are not supported.
Register remote ArcGIS Server services for monitoring
You must be assigned the Administrator or Manager role to register components.
To register ArcGIS Server services hosted on a remote ArcGIS Server site, complete the following steps:
- Access ArcGIS Monitor if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears with registered components listed alphabetically by name.
- Click Register component.
The Register component wizard appears.
Note:
If you don't have sufficient privileges, Register component is not available.
- Choose a Monitor Agent machine that has access to the services, and click Next.
The Component type page appears.
- Under ArcGIS, choose ArcGIS Server (Remote), and click Next.
The Component details page appears.
- Provide a name for the component in the Component name text box.
- Optionally, provide a description for the component in the Description text box.
- Optionally, click Apply Labels
and choose the labels that you want to apply to the component. Tip:
Provide the name of a label in the Enter label name text box to search for a specific label. If the label doesn't exist, click Create new label to add the label and apply it to the component.
- Click Next.
The Connection page appears.
- Provide the ArcGIS Server Services Directory REST API URL in the Address text box.
- If the services are secured, provide the credentials required to access the services in the Username and Password text boxes.
- Click Register component.
The Edit inventory dialog box appears with a list of available services.
- Optionally, do any or all of the following:
- Click the Name A-Z drop-down arrow to change the sorting method.
- Type a keyword in the Search by service name text box to search for specific services.
- Check the check box next to the name of each service that you want to monitor.
You can monitor up to 30 services for each ArcGIS Server (Remote) component.
Tip:
The services to be monitored can be managed by editing the component's Inventory - ArcGIS Server (Remote) observer settings.
- Click Save.
The component is added to the list of monitored components on the Monitoring page.
Observers
The following table describes the observers that collect remote ArcGIS Server site attribute and metric data:
| Observer name | Description |
|---|---|
Check - Remote Service | This optional, user-configured observer sends a request to an ArcGIS Server service and uses a regular expression pattern to validate its JSON response. |
Inventory - ArcGIS Server (Remote) | This observer manages attribute data, scans for ArcGIS Server services across the remote ArcGIS Server site, and its configuration defines the services to be monitored. The default interval for this observer is 5 minutes; however, you can configure it to run at longer intervals since changes to the remote site configuration are typically infrequent. |
Metrics - ArcGIS Server (Remote) | This observer collects availability and performance metric data for monitored services. The default interval for this observer is 5 minutes; however, you can configure it to run at shorter intervals to retrieve data more frequently. |
Collected attributes
The subsections below describe the attributes that are collected for the remote ArcGIS Server site and its monitored services.
ArcGIS Server (Remote)
The following table lists the attribute that is collected for the remote ArcGIS Server site:
| Attribute name | Description | Data type |
|---|---|---|
Version | The software version of the ArcGIS Server site | String |
Remote ArcGIS Server services
The following table lists the attribute that is collected for remote ArcGIS Server services:
| Attribute name | Description | Data type |
|---|---|---|
Is remote | Specifies whether the service is remote | Boolean |
Collected metrics
The subsections below describe the metrics that are collected for the remote ArcGIS Server site and its monitored services.
ArcGIS Server (Remote) metrics
The following table lists the metrics that are collected for the remote ArcGIS Server site:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Connectivity | The agent's ability to successfully connect to the component | Float | Percent |
Response Code | The request HTTP response code | Float | Total |
Response Size | The size of the response payload | Float | Kilobytes |
Response Time | The response time of the ArcGIS Server site | Float | Seconds |
Remote ArcGIS Server services metrics
The following table lists the metrics that are collected for the remote ArcGIS Server site's monitored services:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Connectivity | The agent's ability to successfully connect to the service | Float | Percent |
Response Code | The request HTTP response code | Float | Total |
Response Size | The size of the response payload | Float | Kilobytes |
Response Time | The response time of the service | Float | Seconds |
Remote ArcGIS Server services optional metrics
The following metrics can be collected by configuring the Check - Remote Service observer for remote ArcGIS Server services:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Check Response Code - <observer_name> | The request HTTP response code. | Float | Total |
Check Response Matches - <observer_name> | The total number of matches returned by the regular expression defined in the observer. Note:If no regular expression is defined, a null value is returned. | Float | Total |
Check Response Size - <observer_name> | The size of the response payload. | Float | Kilobytes |
Check Response Time - <observer_name> | The response time of the check. | Float | Seconds |
Enable optional metrics
To enable optional metrics for remote ArcGIS Server services, complete the following steps:
- Access ArcGIS Monitor if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears with registered components listed alphabetically by component name.
- Click the name of the remote ArcGIS Server service for which you want to enable optional metrics.
The services's Overview page appears with its details and an overview of its metrics.
Tip:
You can type a keyword in the Search by component name or address text box to search for specific components and subcomponents.
- Click the Observers tab.
The Observers page appears.
- Click Add observer.
The Add observer dialog box appears.
- Choose Check - Remote Service, and click Next.
The Observer details page appears.
- Provide a name for the observer in the Observer name text box.
The observer name is used to identify the observer, and all metrics associated with the observer are prefixed with the observer name. For example, if the observer name is Health Check, the name of its metrics would be <MetricName> - health_check.
- Optionally, provide a description for the observer in the Description text box.
- Click Next.
The Configuration page appears.
- Click the Interval drop-down arrow, and choose an interval.
- Provide the resource and operation in the Request URL text box.
The following is an example of the query operation for layer 0 of the Sample World Cities map service:
/0/query
Note:
The observer inherits the credentials of the associated remote ArcGIS Server component and automatically sets the response format to JSON.
- Click the Request method drop-down arrow, and choose the type of request that you want to send to the service.
- Optionally, provide key-value pairs for data that you want to be sent in the URL query string (GET) or request body (POST) under Request data.
For example, to return the total number of features in layer 0 of the Sample World Cities map service, add the following key-value pairs:
Key Value where
1=1
returnCountOnly
true
Note:
The f parameter is automatically set to json when the request is sent.
- Optionally, provide a regular expression pattern to validate the request's JSON response in the Response check text box.
For example, to determine if there are 2,232 features in layer 0 of the Sample World Cities map service, add the following regular expression pattern:
\b2232\b
The ignoreCase, multiline, and global properties are used when validating the JSON response.
- Click Next.
The Test page appears.
- Click Test to validate the configuration.
The result of the test appears on the Test page.
- Click Add observer.
The observer is added to the list of observers on the Observers page.
Optional metrics are collected and automatically appear in Monitor according to the observer's configured interval.
Default alert rules
The subsections below describe the default alert rules that are configured for the remote ArcGIS Server site and its monitored services.
ArcGIS Server (Remote) alert rules
The following table lists the default alert rules that are configured for the remote ArcGIS Server site:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
Connectivity | Average | Is less than | — | — | 100 | 2 |
Response Code | Average | Is greater than or equal to | 300 | 400 | 500 | 1 |
Note:
The default alert rules in the table above are the rules that are configured for components when Monitor is first deployed. If your Monitor administrator configured default alert rules for the Monitor deployment, the values for the rules above may vary.
Remote ArcGIS Server services alert rules
The following table lists the default alert rule that is configured for the remote ArcGIS Server site's monitored services:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
Response Code | Average | Is greater than or equal to | 300 | 400 | 500 | 1 |
Note:
The default alert rule in the table above is the rule that is configured for components when Monitor is first deployed. If your Monitor administrator configured default alert rules for the Monitor deployment, the values for the rule above may vary.
Remote ArcGIS Server services optional metrics alert rules
The following table lists the default alert rule that is configured for optional metrics for remote ArcGIS Server services:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
<observer_name> | Average | Is greater than or equal to | 300 | 400 | 500 | 1 |
Note:
The default alert rule in the table above is the rule that is configured for components when Monitor is first deployed. If your Monitor administrator configured default alert rules for the Monitor deployment, the values for the rule above may vary.