You can register Microsoft Windows hosts to collect system health and performance metrics, such as CPU speed and available memory.
Note:
Each host must have its own installation of ArcGIS Monitor Agent. Once Monitor Agent is registered with Monitor Server, the host is automatically registered for monitoring.
Prerequisites for monitoring
The following prerequisites are necessary for monitoring Windows hosts:
- The Windows host must be running a version of the Windows operating system that is supported by Microsoft.
- The ArcGIS Monitor account must be part of the Windows Performance Monitor Users group.
- Microsoft PowerShell must be installed and included in the Windows system PATH environment variable.
Register Windows hosts for monitoring
You must be assigned the Administrator or Manager role to register components.
To register a Windows host component, complete the following steps:
- Install Monitor Agent on the Windows host machine that you want to register.
- Open a command prompt window on the Monitor Agent machine.
- Run the command below, editing the command line parameters to include the root URL to Monitor Server and your username and password.
<Monitor Agent installation location>\arcgis-monitor-agent.exe admin:system:register --server-url <https://monitorserver.example.com:30443/arcgis> --username <user> --password <password>
The following is an example:
"C:\Program Files\ArcGIS\Monitor\Agent\arcgis-monitor-agent.exe" admin:system:register --server-url https://monitorserver.example.com:30443/arcgis --username jdoe --password "my password"
The Monitor Agent instance is registered with Monitor Server. The host machine is automatically registered as a Windows host component and 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, are automatically discovered on the host machine and must be registered individually to enable monitoring.
Observers
The following table describes the observers that collect attribute and metric data:
| Observer name | Description |
|---|---|
Inventory - Host Windows | This observer scans for changes and manages attribute data and component relationships 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 host's configuration are typically infrequent. |
Metrics - Host Windows | This 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 | String |
Storage attributes
The following table lists the attribute that is 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 the 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 | The agent'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 available. | 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 page file or swap memory resources available. | Float | Gigabytes |
Pagefile Used | The total page file or swap memory resources in use. | Float | Gigabytes |
Pagefile Utilized | The proportion of page file 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. | 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 the metrics collected for a Windows host's storage resources:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
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 | 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 configured default alert rules for the Monitor deployment, the values for the rules above may vary.
Component relationships
The subsections below describe the relationships that are automatically formed with registered Windows host components.
Storage
The host's inventory observer detects local storage devices attached to the host machine and forms individual relationships between the host component and each storage subcomponent.
Note:
If a host component is unregistered in Monitor, all relationships to the host component are removed, and its storage subcomponents are unregistered.
ArcGIS Data Store
The host's inventory observer detects the ArcGIS Data Store system service running on the host machine. If the detected Data Store instance is configured as a relational data store and registered for monitoring, a relationship is formed between the host component and the ArcGIS Data Store component.
Note:
For highly available Data Store deployments with multiple hosts, each host machine and Data Store instance in the deployment must be registered for relationships to be formed between the individual Data Store components and participating host machines.
ArcGIS GeoEvent Server
The host's inventory observer detects the ArcGIS GeoEvent Server system service running on the host machine. If the detected GeoEvent Server instance is registered for monitoring, a relationship is formed between the host component and the ArcGIS GeoEvent Server component.
Note:
GeoEvent Server does not support highly available deployments.
ArcGIS Server
The host's inventory observer detects the ArcGIS Server system service running on the host machine. If the detected ArcGIS Server instance is registered for monitoring, a relationship is formed between the host component and the ArcGIS Server component.
Note:
For highly available ArcGIS Server deployments with multiple hosts, each host machine and ArcGIS Server instance in the deployment must be registered for monitoring for relationships to be formed between the individual host machines and ArcGIS Server components.
Portal for ArcGIS
The host's inventory observer detects the Portal for ArcGIS system service running on the host machine. If the detected Portal for ArcGIS instance is registered for monitoring, a relationship is formed between the host component and the Portal for ArcGIS component.
Note:
For highly available Portal for ArcGIS deployments with multiple hosts, each host machine and Portal for ArcGIS instance in the deployment must be registered for monitoring for relationships to be formed between the individual host machines and Portal for ArcGIS components.
Microsoft SQL Server
The host's inventory observer detects system services with the MSSQL prefix running on the host machine. If the detected SQL Server instance contains one or more databases that are registered for monitoring, individual relationships are formed between the host component and each registered SQL Server database component.
Oracle
The host's inventory observer detects system services with the OracleService prefix running on the host machine. If the detected Oracle instance contains one or more databases that are registered for monitoring, individual relationships are formed between the host component and each registered Oracle database component.
PostgreSQL
The host's inventory observer detects system services with the postgresql prefix running on the host machine. If the detected PostgreSQL instance contains one or more databases that are registered for monitoring, individual relationships are formed between the host component and each registered PostgreSQL database component.