You can register Microsoft Windows hosts to collect system health and performance metrics.
Prerequisites for monitoring
The following prerequisites are necessary for monitoring Windows hosts:
- The Windows host that you want to register must be running a version of the Windows operating system (OS) that is supported by Microsoft.
- The Windows Remote Management (WS-Management) service must be running and set to automatic startup on the Windows host that you want to register for monitoring.
- The ArcGIS Monitor Server or ArcGIS Monitor Agent machine where the Windows host is registered must be running on a Windows OS.
- Your firewall must allow communication between the Windows host and the ArcGIS Monitor machine where it will be registered on port 5985 for an HTTP connection or port 5986 for an HTTPS connection.
Note:
If the Windows host is configured to run WinRM on a different port, communication must instead be allowed on that port.
- The user account that you use to register the Windows host must be part of the Remote Management Users and Performance Monitor Users groups and have Enable Account and Remote Enable permissions to the WMI cimv2 namespace and subnamespaces.
- When registering a Windows host with an IP address, you must do the following:
- Add the IP address of the Windows host to the TrustedHosts list on the ArcGIS Monitor Server or ArcGIS Monitor Agent machine where it is registered.
- Provide user credentials for authentication. The ArcGIS Monitor account credentials cannot be inherited for authentication.
Register Windows hosts for monitor
You must be assigned the Administrator or Manager role to register components. To register a Windows host component, complete the following steps:
- 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.
- Click Register component.
The Register component wizard appears.
Note:
If you don't have sufficient privileges, Register component 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.
- Under Host, choose Windows 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 Apply Labels
and choose the labels that you want to apply to the component. Tip:
Type the name of a label in the Enter label name text box to search for a specific label. If the label that you want to add doesn't exist, type the name of the label that you want to create in the Enter label name text box and click Create new label to add the label and apply it to the component.
- Click Next.
The Connection page appears.
- Type the fully qualified domain name (FQDN) or IP address of the host you want to register in the Address text box.
- Provide the credentials
for the host by doing one of the following:
- Provide credentials in the Username and Password text boxes.
- Check the Inherit credentials check box to use the ArcGIS Monitor account credentials for authentication.
This option can only be used when the FQDN of the host is provided in the Address text box. If an IP address is provided in the Address text box, you must provide credentials for the host in the Username and Password text boxes.
- 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 software component types, such as ArcGIS software and databases, must be registered individually to enable monitoring.
Observers
The following table describes the observers that are responsible for collecting Windows host attribute and metric data:
| Observer name | Description |
|---|---|
Discover | The Discover observer scans for changes and manages attribute data across the Windows host. The default interval for this observer is 15 minutes; however, you can configure it to run at longer intervals since changes to the underlying site configuration are expected to be infrequent. |
Metrics | The Metrics observer collects Windows host metric data. 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. |
Collected attributes
The subsections below describe the attributes that are collected for Windows hosts.
Host attributes
The following table lists the attributes that are collected for Windows hosts:
| Attribute name | Description | Data type |
|---|---|---|
Class | The instance type (virtual or physical) | String |
CPU cores logical | The CPU's total number of logical cores | Integer |
CPU cores physical | The CPU's total number of physical cores | Integer |
CPU name | The CPU name and model information | String |
CPU speed | The speed of the CPU | Float |
Memory total | The host's total amount of memory (RAM) | Float |
Network speed | The speed of the network | Integer |
Started at | The date and time the host was last started | Datetime |
UTC offset | The host's UTC time zone offset | Integer |
Version | The software version of the operating system (OS) | String |
Storage attributes
The following table lists the attributes that are collected for a Windows host's storage resources:
| Attribute name | Description | Data type |
|---|---|---|
Storage total | The size of the volume | Float |
Collected metrics
The subsections below describe metrics that are collected for Windows hosts.
Host metrics
The following table lists the metrics collected for Windows hosts:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Connectivity - <Discovery observer r_id> | The observer's ability to successfully connect to the component. | Float | Percent |
Connectivity - <Metrics observer r_id> | The observer's ability to successfully connect to the component. | Float | Percent |
CPU Cores Utilized | The number of logical CPU cores in use. | Float | Total |
CPU Utilized | The proportion of CPU resources in use. Values approaching 100 percent may indicate that more resources are needed to handle the workload. | Float | Percent |
Memory Available | The total amount of memory. | Float | Gigabytes |
Memory Used | The amount of physical memory in use. | Float | Gigabytes |
Memory Utilized | The proportion of memory in use. Values approaching 100 percent may indicate that more resources are needed to handle the workload. | Float | Percent |
Network Incoming | The rate of network data received. | Float | Megabits/second |
Network Incoming Utilized | The proportion of incoming network bandwidth in use. | Float | Percent |
Network Outgoing | The rate of network data sent. | Float | Megabits/second |
Network Outgoing Utilized | The proportion of outgoing network bandwidth in use. | Float | Percent |
Pagefile Available | The total pagefile or swap memory resources available. | Float | Gigabytes |
Pagefile Used | The total pagefile or swap memory resources in use. | Float | Gigabytes |
Pagefile Utilized | The proportion of pagefile or swap memory resources in use. | Float | Percent |
Terminal Sessions | The total number of terminal sessions. | Float | Total |
Terminal Sessions Active | The total number of active terminal sessions. | Float | Total |
Terminal Sessions Inactive | The total number of inactive terminal sessions. | Float | Total |
Process metrics
Monitor collects information about the following processes:
- arcgispro.exe
- arcmap.exe
- arccatalog.exe
- arcgisserver.exe
- arcsoc.exe
- arcgisportal.exe
- geoeventserver.exe
- python.exe
- powershell.exe
- sqlserver.exe
- postgres.exe
- oracle.exe
The following table lists the metrics collected for a Windows host's processes:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Process CPU Utilized | The proportion of CPU resources in use by the process. Values approaching 100 percent may indicate that more resources are needed to handle the workload. | Float | Percent |
Process Instances | The number of process instances that are running by the process. | Float | Total |
Process Memory Used | The amount of memory resources in use by the process. | Float | Gigabytes |
Process Memory Utilized | The proportion of memory in use by the process. Values approaching 100 percent may indicate that more resources are needed to handle the workload. | Float | Percent |
Storage metrics
The following table lists metrics collected for a Windows host's storage resources:
| Metric name | Description | Data type | |
|---|---|---|---|
Storage Capacity Available | The amount of available storage space | Float | Gigabytes |
Storage Capacity Used | The amount of storage space in use | Float | Gigabytes |
Storage Capacity Utilized | The proportion of storage capacity in use | Float | Percent |
Storage Read Rate | The speed at which data is read from the disk | Float | Gigabytes/second |
Storage Write Rate | The speed at which data is written to the disk | Float | Gigabytes/second |
Default alert rules
The following table lists the default alert rules that are configured for Windows hosts:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
Connectivity - <Discover observer r_id> | Average | Is less than | — | — | 100 | 2 |
Connectivity - <Metrics observer r_id> | Average | Is less than | — | — | 100 | 2 |
CPU Utilized | Average | Is greater than | — | 75 | 90 | 3 |
Memory Utilized | Average | Is greater than | — | 75 | 90 | 3 |
Pagefile Utilized | Average | Is greater than | — | 75 | 90 | 3 |
Process CPU Utilized | Average | Is greater than | — | 75 | 90 | 3 |
Process Memory Utilized | Average | Is greater than | — | 75 | 90 | 3 |
Storage Capacity Utilized | Average | Is greater than | — | 75 | 90 | 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 has configured default alert rules for the Monitor deployment, the values for the rules above may vary.