You can register stand-alone and federated ArcGIS Server sites to collect system health and performance metrics.
Prerequisites for monitoring
The following prerequisites are necessary for monitoring ArcGIS Server sites:
- ArcGIS Monitor Agent must be installed on at least one ArcGIS Server machine and must be registered with ArcGIS Monitor Server.
When monitoring a multimachine site, it is recommended that you install Monitor Agent on all machines in the site. This ensures continuous monitoring of the site in the event of a machine failure and provides host metrics for each machine in the site.
- ArcGIS Server must be running on ArcGIS Enterprise version 10.7.1 or later.
- The ArcGIS Server primary site administrator or an equivalent ArcGIS Server user account that is assigned the Administrator role type is required to register an ArcGIS Server site for monitoring.
Note:
For a federated ArcGIS Server site, the ArcGIS Server primary site administrator user account is required.
- Authentication requires ArcGIS Server token-based security. Other forms of authentication such as Integrated Windows Authentication (IWA) and Security Assertion Markup Language (SAML) are not supported.
- When an ArcGIS Server site is registered with Monitor, the following changes are made to the ArcGIS Server settings:
- The monitorSystemId field is added to the Server Properties object and contains a unique identifier for the ArcGIS Server site.
- Monitor manages Usage Report settings. The samplingInterval parameter is set to 1 minute to align with the Metrics - ArcGIS Server observer's interval, and the maxHistory parameter is set to 1 day to prevent unnecessary history from accumulating.
- A Monitor-managed usage report is added to support the collection of metrics. The usage report name is prefixed with agm- followed by a unique Monitor deployment identifier.
Register an ArcGIS Server site for monitoring
You must be assigned the Administrator or Manager role to register components.
To register an ArcGIS Server component, complete the following steps:
- Access ArcGIS Monitor if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears. Registered components are listed alphabetically by component name.
- Click Register component.
The Register component wizard appears.
Note:
If you don't have sufficient privileges, Register component is not available.
- Choose the Monitor Agent machine where the component is installed.
The Component type page appears.
- Under ArcGIS, choose ArcGIS Server 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 credentials
of an ArcGIS Server site administrator in the Username and Password text boxes.
- For federated ArcGIS Server sites, you must provide credentials for the ArcGIS Server primary site administrator account to register the site.
- For unfederated ArcGIS Server sites, you must provide credentials for an ArcGIS Server user account with the Administrator role to register the site.
- Click Register component.
The component is added to the list of monitored components on the Monitoring page.
Once a component is registered, you can configure alert rules and add the component to collections.
Note:
Other component types, such as the enterprise GIS implementation's underlying hardware infrastructure and databases, must be registered individually to enable monitoring.
Observers
The following table describes the observers that are responsible for collecting ArcGIS Server site attribute and metric data:
| Observer name | Description |
|---|---|
Check - 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 | This observer scans for changes and manages attribute data across the ArcGIS Server site and its underlying services. The default interval for this observer is 5 minutes; however, you can configure it to run at longer intervals since changes to the site configuration are typically infrequent. |
Logs - ArcGIS Server | This observer collects log entries for the ArcGIS Server site for display in Monitor. The default interval for this observer is 1 minute to retrieve data frequently. It is recommended that you do not run this observer at longer intervals. |
Metrics - ArcGIS Server | This observer collects metric data across the ArcGIS Server site and its underlying 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 ArcGIS Server site and its underlying services.
ArcGIS Server
The following table lists the attributes that are collected for the ArcGIS Server site:
| Attribute name | Description | Data type |
|---|---|---|
License expiration | The date and time the ArcGIS Server site's license expires | Datetime |
Machines | The list of machines or hosts that participate in the ArcGIS Server site | Array |
Roles | The list of ArcGIS Server roles assigned to the ArcGIS Server site | Array |
Shared instances max | The maximum number of shared service instances | Integer |
Shared instances min | The minimum number of shared service instances | Integer |
Started at | The date and time the ArcGIS Server site was last started | Datetime |
Version | The software version of the ArcGIS Server site | String |
ArcGIS Server services
The following table lists the attributes that are collected for the ArcGIS Server site's underlying services:
| Attribute name | Description | Data type |
|---|---|---|
Cached service | Specifies whether data is returned dynamically or returned from a cache when queried. | Boolean |
Configured state | Specifies the state of the service as it is configured in ArcGIS Server (started or stopped). | String |
Idle time max | The maximum number of seconds a service instance is allowed to persist before it shuts down. | Integer |
Instance type | Specifies the infrastructure of the underlying service provider (hosted, shared, dedicated, or custom). | String |
Instances max | The maximum number of service instances configured across the ArcGIS Server site. For hosted and custom instances, this value is always displayed as zero. For shared instances, this value is the maximum number of shared instances configured for the site. For dedicated instances, this is the maximum number of instances configured for the service. | Integer |
Instances min | The minimum number of service instances configured across the ArcGIS Server site. For hosted and custom instances, this value is always displayed as zero. For shared instances, this value is the minimum number of shared instances configured for the site. For dedicated instances, this is the minimum number of instances configured for the service. | Integer |
Wait time max | The maximum number of seconds a client waits to connect to the service before it times out. | Integer |
Collected metrics
The subsections below describe the metrics that are collected for the ArcGIS Server site and its underlying services.
ArcGIS Server metrics
The following table lists the metrics that are collected for the ArcGIS Server site:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Connectivity | The agent's ability to successfully connect to the component. | Float | Percent |
Instances Saturation Percent | The proportion of maximum configured service instances in use. This metric is calculated by dividing the service's busy time with its maximum potential busy time, and multiplying this value by 100. The service busy time is calculated by multiplying the service's average response time (RT) by the number of requests (RR) over the interval. The maximum potential busy time is calculated by multiplying the service's maximum configured instances (IC) by the interval (I). The following is an example: Values approaching 100 percent may indicate that more instances are needed to handle incoming service requests. | Float | Percent |
Instances Used | The total number of service instances in use. This metric is calculated by taking the instances saturation percent metric value (ISP) and dividing it by 100, and multiplying this value by the maximum configured instances (IC). The following is an example. | Float | Total |
Request Rate | The average request rate of all ArcGIS Server site services. | Float | Requests/second |
Request Response Time Avg | The average response time of all ArcGIS Server site services. | Float | Seconds |
Request Response Time Max | The maximum response time of all ArcGIS Server site services. | Float | Seconds |
Request Wait Time Average | The average time that all requests waited for an available ArcSOC instance over a period of time (total wait time for all requests divided by the number of requests). | Float | Seconds |
Request Wait Time Max | The maximum time that a service request waited for an available ArcSOC instance over the specified period. | Float | Seconds |
Request Wait Time Min | The minimum time that a service request waited for an available ArcSOC instance over the specified period. | Float | Seconds |
Requests Error Percent | The percentage of failed and timed-out requests of all ArcGIS Server site services. | Float | Percent |
Requests Failed | The total number of failed requests of all ArcGIS Server site services. | Float | Total |
Requests Received | The total number of received requests of all ArcGIS Server site services. | Float | Total |
Requests Timed Out | The total number of timed-out requests of all ArcGIS Server site services. | Float | Total |
Services | The total number of ArcGIS Server services. | Float | Total |
Site Machines Availability | The total percentage of machines that are available in the ArcGIS Server site. Values under 100 percent indicate that some of the machines in the site are unavailable for processing and may require further investigation. | Float | Percent |
ArcGIS Server services metrics
Monitor collects information about the following ArcGIS Server service types:
- Feature
- Geocode
- Geodata
- Map
- Network Analyst
- Geoprocessing
The following table lists the metrics that are collected for the ArcGIS Server site's underlying services:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Instances Saturation Percent | The proportion of maximum configured service instances in use. Values approaching 100 percent may indicate that more instances are needed to handle incoming service requests. | Float | Percent |
Instances Used | The total number of service instances in use. | Float | Total |
Request Rate | The service's average request rate. | Float | Requests/second |
Request Response Time Avg | The service's average response time. | Float | Seconds |
Request Response Time Max | The service's maximum response time. | Float | Seconds |
Requests Error Percent | The proportion of failed and timed-out service requests. | Float | Percent |
Requests Failed | The total number of failed service requests. | Float | Total |
Requests Received | The total number of received service requests. | Float | Total |
Requests Timed Out | The total number of service requests that timed out. | Float | Total |
Optional metrics
The following metrics can be collected by configuring the Check - Service observer for ArcGIS Server services:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Check Response Code - <ObserverName> | The request's HTTP response code. | Float | Total |
Check Response Size - <ObserverName> | The size of the response payload. | Float | Kilobytes |
Check Response Matches - <ObserverName> | 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 Time - <ObserverName> | The response time of the check. | Float | Seconds |
Enable optional metrics
To enable optional metrics for ArcGIS Server services, complete the following steps:
- Access ArcGIS Monitor if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears. Registered components are listed alphabetically by component name.
- Click the name of the ArcGIS Server service subcomponent for which you want to enable optional metrics.
The subcomponent'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 Add observer.
The Add observer dialog box appears.
- Choose Check - Service and click Next.
The Observer details page appears.
- Provide a name for the observer in the Observer name text box.
The observer's name is prefixed with Check - Service. For example, if the name you provided in the Observer name text box is Sample World Cities Row Count, the observer name would be Check - Service - Sample World Cities Row Count.
- 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 URL of the ArcGIS Server service you want to monitor in the URL text box.
The following URL is an example for layer 0 of the Sample World Cities map service:
https://gisserver.domain.com/arcgis/rest/services/SampleWorldCities/MapServer/0/query
Note:
The observer inherits the credentials of the associated 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 Regular expression 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 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 ArcGIS Server site and its underlying services.
ArcGIS Server alert rules
The following table lists the default alert rules that are configured for the ArcGIS Server site:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
Connectivity | Average | Is less than | — | — | 100 | 2 |
Request Rate | Average | Is greater than or equal to | 1 | 10 | 30 | 3 |
Request Response Time Avg | Average | Is greater than or equal to | 1 | 3 | 6 | 3 |
Request Response Time Max | Average | Is greater than or equal to | 1 | 3 | 6 | 3 |
Requests Error Percent | Average | Is greater than or equal to | — | 5 | 30 | 3 |
Site Machines Availability | Average | Is less than or equal to | — | 99 | 0 | 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.
ArcGIS Server services alert rules
The following table lists the default alert rules that are configured for the ArcGIS Server site's underlying services:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
Instances saturation percent | Average | Is greater than or equal to | — | 50 | 90 | 3 |
Request rate | Average | Is greater than or equal to | 1 | 10 | 30 | 3 |
Request response time average | Average | Is greater than or equal to | 1 | 3 | 6 | 3 |
Request response time max | Average | Is greater than or equal to | 1 | 3 | 6 | 3 |
Requests error percent | Average | Is greater than or equal to | — | 5 | 30 | 3 |
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.