Skip To Content

Register Linux hosts

You can register Linux hosts to collect system health and performance metrics.

Prerequisites for monitoring

The following prerequisites are necessary 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.
  • The firewall must allow communication between the Linux host and the ArcGIS Monitor machine where 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.

  1. Access ArcGIS Monitor, if necessary.

    The Home page appears.

  2. Click Monitoring.

    The Monitoring page appears with a list of components sorted alphabetically by component name.

  3. Click Register component.

    The Register component wizard appears.

    Note:

    If you don't have sufficient privileges, Register component is not available.

  4. 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.

  5. Under Host, choose Linux and click Next.

    The Component details page appears.

  6. Type a name for the component in the Component name text box.
  7. Optionally, type a description for the component in the Description text box.
  8. Optionally, click Apply Labels 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.

  9. Click Next.

    The Connection page appears.

  10. Type the fully qualified domain name or IP address of the host you want to register in the Address text box.
  11. 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 the 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.

  12. 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 Linux host attribute and metric data:

Observer nameDescription

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, 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 Linux 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 Linux hosts.

Host attributes

The following table lists the attributes that are collected for Linux hosts:

Attribute nameDescriptionData 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 table lists the attributes collected for a host's storage resources:

Attribute nameDescriptionData type

Storage total

The size of the volume

Float

Collected metrics

The subsections below describe the metrics that are collected for Linux hosts.

Host metrics

The following table lists the metrics collected for Linux hosts:

Metric nameDescriptionData typeUnit

Connectivity - <Discover 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 physical memory.

Float

Gigabytes

Memory Used

The amount of 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

Process metrics

Monitor collects information about the following processes:

  • arcgisserver
  • arcsoc
  • arcgisportal
  • geoeventserver
  • python
  • sqlserver
  • postgres
  • oracle

The following table lists the metrics collected for a Linux host's processes:

Metric nameDescriptionData typeUnit

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 total 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 host's storage resources:

Metric nameDescriptionData typeUnit

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 Linux hosts:

Metric nameAggregationOperatorInfo thresholdWarning thresholdCritical thresholdSamples

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.

Related topics