You can register stand-alone and federated ArcGIS Server sites to collect system health and performance metrics.
Prerequisites for monitoring
The following is a list of prerequisites for monitoring ArcGIS Server sites:
- ArcGIS Server must be running on ArcGIS Enterprise version 10.6 or later.
- The ArcGIS Server primary site administrator or an equivalent ArcGIS Server user account that is assigned an Administrator role type is required to register an ArcGIS Server site for monitoring.
- 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 registering a multi-machine ArcGIS Server site, you only need to register one machine that participates in the site. The machine that you register is designated as the primary machine with which ArcGIS Monitor communicates. If the machine becomes unavailable, Monitor automatically attempts to communicate with other machines in the site to continue collecting data.
Tip:
To monitor the underlying infrastructure that makes up your ArcGIS Server site, you must register each machine in the site as a Host component. If your ArcGIS Server machines are hosted in an Amazon Web Services cloud environment, you must register a Cloud component and tag each machine for monitoring.
- When registered using the URL of an individual ArcGIS Server machine in an ArcGIS Server site, your firewall must allow communication between all machines in the site and the ArcGIS Monitor machine to which the site is registered on port 6080 for an HTTP connection or port 6443 for an HTTPS connection.
- When registered using the URL of ArcGIS Web Adaptor or a third-party load balancer, your firewall must allow communication between ArcGIS Web Adaptor or the third-party load balancer and the ArcGIS Monitor machine to which the ArcGIS Server site is registered.
Register an ArcGIS Server site for monitoring
You must be assigned the Administrator or Manager role to register components. Complete these steps to register an ArcGIS Server component:
- Access ArcGIS Monitor, if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears with a list of components sorted alphabetically by component name.
Tip:
Click Labels to filter the list using labels, click Sort to change the sorting method, click Filter to create a query and filter the list, click Hide to choose which columns to show and hide, and click the categories at the side of the page to filter the list by the chosen category. You can also search for specific components by typing a keyword in the Search by component name or address text box.
- Click Register Component.
The Register Component wizard appears.
Note:
If you don't have sufficient privileges, the Register Component button is not available.
- Choose the ArcGIS Monitor Server or ArcGIS Monitor Agent machine that has network access to the component that you want to register and click Next.
The Component Type page appears.
- Choose ArcGIS Server under ArcGIS and click Next.
The Component Details page appears.
- Type a name for the component in the Component Name text box.
- Optionally, type a description for the component in the Description text box.
- Optionally, click the Labels drop-down arrow and choose the labels that you want to apply to the component.
Tip:
If the label that you want to add doesn't exist, type the name of the label in the Labels text box and click Add Label to add the label and apply it to the component.
- Click Next.
The Connection page appears.
- Provide the address to the ArcGIS Server site that you want to register in the Address text box using one of the following methods:
- Provide the URL of an individual ArcGIS Server machine in the site using the following syntax: https://gisserver.domain.com:6443/arcgis. This connection method reduces network hops and the complexity of the network connection. This is the preferred connection method.
- Provide the URL of the site's web adaptor using the following syntax: https://webadaptorhost.domain.com/webadaptorname. This method restricts Monitor from communicating with the site's individual machines and requires all communications to pass through ArcGIS Web Adaptor. This connection method is not supported when web tier authentication is enabled.
- Provide the URL of the site's third-party load balancer using the following syntax: https://loadbalancerhost.domain.com/loadbalancername. This method restricts Monitor from communicating with individual machines within the site and requires all communications to pass through the third-party load balancer. This connection method is not supported when web tier authentication is enabled.
- 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 is a list of observers that are responsible for collecting ArcGIS Server site attribute and metric data:
| Observer name | Description |
|---|---|
Discover | The Discover observer scans for changes and manages attribute data across the ArcGIS Server site and its underlying services. The default interval for this observer is set to 5 minutes; however, it can be configured to run at longer intervals since changes to the underlying site configuration are expected to be infrequent. |
Logs | The Logs observer collects log entries for the ArcGIS Server site for display in Monitor. The default interval for this observer is set to 1 minute to retrieve data more frequently. It is not recommended that you run this observer at longer intervals. |
Metrics | The Metrics observer collects metric data across the ArcGIS Server site and its underlying services. The default interval for this observer is set to 1 minute to retrieve data more frequently. It is not recommended that you run this observer at longer intervals. |
Collected attributes
The following sections list the attributes that are collected for the ArcGIS Server site and its underlying services.
ArcGIS Server
The following is a list of 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 is a list of attributes that are collected for the ArcGIS Server site's underlying services:
| Attribute name | Description | Data type |
|---|---|---|
Cached Service | Specifies if data is returned dynamically or returned from a cache when queried. | Boolean |
Configured State | 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 | The infrastructure of the underlying service provider (hosted, shared, or dedicated). | String |
Instances Max | The maximum number of service instances configured across the ArcGIS Server site. For hosted 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 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 following sections list the metrics that are collected for the ArcGIS Server site and its underlying services.
ArcGIS Server metrics
The following is a list of metrics that are collected for the ArcGIS Server site:
| Metric name | Description | Data type |
|---|---|---|
Request Rate | The average request rate of all ArcGIS Server site services. | Float |
Request Response Time Avg | The average response time of all ArcGIS Server site services. | Float |
Request Response Time Max | The maximum response time of all ArcGIS Server site services. | Float |
Requests Error Percent | The percentage of failed and timed out requests of all ArcGIS Server site services. | Float |
Requests Failed | The total number of failed requests of all ArcGIS Server site services. | Float |
Requests Received | The total number of received requests of all ArcGIS Server site services. | Float |
Requests Timed Out | The total number of timed out requests of all ArcGIS Server site services. | Float |
Site Machines Availability | The total percentage of machines that are available in the ArcGIS Server site. Values under 100 indicate that some of the machines in the site are unavailable for processing and may require further investigation. | Float |
ArcGIS Server services metrics
The following is a list of metrics that are collected for the ArcGIS Server site's underlying services:
| Metric name | Description | Data type |
|---|---|---|
Instance Saturation Percent | The proportion of maximum configured service instances in use. Values approaching 100 may indicate that more instances are needed to handle incoming service requests. | Float |
Request Rate | The service's average request rate. | Float |
Request Response Time Avg | The service's average response time. | Float |
Request Response Time Max | The service's maximum response time. | Float |
Requests Error Percent | The proportion of failed and timed out service requests. | Float |
Requests Failed | The total number of failed service requests. | Float |
Requests Received | The total number of received service requests. | Float |
Requests Timed out | The total number of service requests that timed out. | Float |
Default alert rules
The following sections list the default alert rules that are configured for the ArcGIS Server site and its underlying services.
ArcGIS Server alert rules
The following is a list of default alert rules that are configured for the ArcGIS Server site:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
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 |
Site Machines Availability | Average | Is less than or equal to | — | 99 | 0 | 1 |
ArcGIS Server services alert rules
The following is a list of 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 |
|---|---|---|---|---|---|---|
Instance 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 |