You can register Linux hosts to collect system health and performance metrics.
Prerequisites for monitoring
The following is a list of prerequisites for monitoring Linux hosts:
- The Linux host that you want to register must be running a distribution and software version that is supported by ArcGIS Monitor.
- The Linux host that you want to register must have SSH enabled.
- Your firewall must allow communication between the Linux host and the ArcGIS Monitor machine to which it will be registered on port 22.
Note:
If the Linux host is configured to run SSH on a different port, communication must instead be allowed on that port.
- The user account that you use to register the Linux host must have SSH access.
Register Linux hosts for monitoring
You must be assigned the Administrator or Manager role to register components. Complete these steps to register Linux hosts:
- 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, 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.
- Choose Linux under Host 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.
- Type the fully qualified domain name or IP address of the host you want to register in the Address text box.
- Provide the credentials
for the host using one of the following methods:
- Provide credentials in the Username and Password text boxes.
- Provide a username in the Username text box, check the SSH Key Credentials check box, and provide a passphrase in the Passphrase text box if your SSH key file is encrypted.
Note:
When the SSH Key Credentials check box is checked, the credentials are imported from the ArcGIS Monitor account's SSH keys.
- 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 is a list of observers that are responsible for collecting Linux host attribute and metric data:
| Observer name | Description |
|---|---|
Discover | The Discover observer scans for changes and manages attribute data across the Linux host. The default interval for this observer is 15 minutes; however, it can be configured to run at longer intervals since changes to the underlying site configuration are expected to be infrequent. |
Metrics | The Metrics observer collects Linux host metric data. The default interval for this observer is 1 minute to retrieve data more frequently. It is not recommended that you run this observer at longer intervals. |
Collected attributes
The following is a list of attributes that are collected for Linux hosts.
Host attributes
The following is a list of attributes collected for 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 host's 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 is a list of attributes collected for a host's storage resources:
| Attribute name | Description | Data type |
|---|---|---|
Storage Total | The size of the volume. | Float |
Collected metrics
The following is a list of metrics that are collected for Linux hosts.
Host metrics
The following is a list of metrics collected for hosts:
| Metric name | Description | Data type |
|---|---|---|
CPU Cores Utilized | The number of logical CPU cores in use. | Float |
CPU Utilized | The proportion of CPU resources in use. Values approaching 100 may indicate that more resources are needed to handle the workload. | Float |
Memory Available | The total amount of physical memory. | Float |
Memory Used | The amount of memory in use. | Float |
Memory Utilized | The proportion of memory in use. Values approaching 100 may indicate that more resources are needed to handle the workload. | Float |
Network Incoming | The rate of network data received. | Float |
Network Incoming Utilized | The proportion of incoming network bandwidth in use. | Float |
Network Outgoing | The rate of network data sent. | Float |
Network Outgoing Utilized | The proportion of outgoing network bandwidth in use. | Float |
Pagefile Available | The total pagefile or swap memory resources available. | Float |
Pagefile Used | The total pagefile or swap memory resources in use. | Float |
Pagefile Utilized | The proportion of pagefile or swap memory resources in use. | Float |
Process CPU Utilized | The proportion of CPU resources in use by the process. Values approaching 100 may indicate that more resources are needed to handle the workload. | Float |
Process Instances | The total number of process instances that are running. | Float |
Process Memory Used | The amount of memory resources in use by the process. | Float |
Process Memory Utilized | The proportion of memory in use by the process. Values approaching 100 may indicate that more resources are needed to handle the workload. | Float |
Storage metrics
The following is a list of metrics collected for a host's storage resources:
| Metric name | Description | Data type |
|---|---|---|
Storage Capacity Available | The amount of available storage space. | Float |
Storage Capacity Used | The amount of storage space in use. | Float |
Storage Capacity Utilized | The proportion of storage capacity in use. | Float |
Storage Read Rate | The number of disk reads per second. | Float |
Storage Write Rate | The number of disk writes per second. | Float |
Default alert rules
The following is a list of default alert rules that are configured for Linux hosts:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
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 |