Register Portal for ArcGIS

You can register Portal for ArcGIS to collect system health and performance metrics.

Prerequisites for monitoring

The following is a list of prerequisites for monitoring Portal:

• Portal must be running on ArcGIS Enterprise version 10.6 or later.
• The primary Portal administrator or an equivalent user account that is assigned the Administrator role or an equivalent custom role is required to register Portal for monitoring.
• Your firewall must allow communication between Portal and the ArcGIS Monitor machine to which it will be registered on port 7080 for an HTTP connection or port 7443 for an HTTPS connection.

Register Portal for monitoring

You must be assigned the Administrator or Manager role to register components. Complete these steps to register a Portal for ArcGIS component:

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.

   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.

3. Click Register Component.

   The Register Component wizard appears.

   Note:

   If you don't have sufficient privileges, the Register Component button 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. Choose Portal for ArcGIS under ArcGIS 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 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.

9. Click Next.

   The Connection page appears.

10. Type the URL to the Portal REST Admin Root for the Portal you want to register in the Address text box.

    An example is https://myserver.mydomain:7443/arcgis.

11. Provide the credentials for Portal in the Username and Password text boxes.
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 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 Portal attribute and metric data:

Observer name	Description
Discover	The Discover observer scans for changes and manages attribute data across Portal. The default interval for this observer is set to 15 minutes; however, it can be configured to run at longer intervals since changes to the underlying site configuration are expected to be infrequent.
Health Checks	The Health Checks observer collects Portal health data. The default interval for this observer is set to 15 minutes; however, it can be configured to run at shorter intervals to retrieve data more frequently.
Logs	The Logs observer collects Portal log entries. The default interval for this observer is set to 5 minutes; however, it can be configured to run at shorter intervals to retrieve data more frequently.
Metrics	The Metrics observer collects Portal metric data. 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 is a list of attributes that are collected for Portal:

Attribute name	Description	Data type
Certificate Expiration	The date and time the configured server certificate for Portal expires.	Datetime
License Expiration	The date and time the Portal license expires.	Datetime
Started At	The date and time Portal was last started.	Datetime
Version	The software version of Portal.	String

Collected metrics

The following is a list of metrics that are collected for Portal:

Metric name	Description	Data type
Federation Health Check Status	The overall status of the federation between Portal and all federated ArcGIS Server machines. A value of 1 is returned if the status is healthy.	Float
Index Health Check Status	The overall status of all Portal indexes. A value of 1 is returned if the status is healthy.	Float
Total Groups	The total number of groups in Portal.	Float
Total Items	The total number of items in Portal.	Float
Total Users	The total number of users in Portal.	Float

Default alert rules

The following is a list of default alert rules that are configured for Portal:

Metric name	Aggregation	Operator	Info threshold	Warning threshold	Critical threshold	Samples
Federation Health Check Status	Average	Is equal to	—	—	0	1
Index Health Check Status	Average	Is equal to	—	—	0	1