You can register Portal for ArcGIS to collect system health and performance metrics.
Prerequisites for monitoring
The following prerequisites are necessary 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.
- The firewall must allow communication between Portal and the ArcGIS Monitor machine where 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.
- 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 ArcGIS, choose Portal for ArcGIS 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.
- Provide 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.
- Provide the credentials for Portal 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 component types, such as the enterprise GIS implementation's underlying hardware infrastructure and databases, must be registered individually to enable monitoring.
Observers
The following table describes the 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 5 minutes; however, you can configure it 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 5 minutes; however, you can configure it 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 1 minute to retrieve data frequently. It is recommended that you do not run this observer at longer intervals. |
Metrics | The Metrics observer collects Portal 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 following table lists the 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 table lists the metrics that are collected for Portal:
| Metric name | Description | Data type | Unit |
|---|---|---|---|
Connectivity - <Discover observer r_id> | The observer's ability to successfully connect to the component. | Float | Percent |
Connectivity - <Health checks observer r_id> | The observer's ability to successfully connect to the component. | Float | Percent |
Connectivity - <Logs 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 |
Health Check Status - federation | The overall status of the federation between Portal and all federated ArcGIS Server machines. A value of 100% is returned if the status is healthy. | Float | Percent |
Health Check Status - index | The overall status of all Portal indexes. A value of 100% is returned if the status is healthy. | Float | Percent |
Groups | The total number of groups in Portal. | Float | Total |
Groups - org | The total number of organization groups in Portal. | Float | Total |
Groups - private | The total number of private groups in Portal. | Float | Total |
Groups - public | The total number of public groups in Portal. | Float | Total |
Items | The total number of items in Portal. | Float | Total |
Items - app | The total number of app items in Portal. | Float | Total |
Items - data_store | The total number of ArcGIS Data Store items in Portal. | Float | Total |
Items - file | The total number of file items in Portal. | Float | Total |
Items - insight | The total number of ArcGIS Insights items in Portal. | Float | Total |
Items - layer | The total number of layer items in Portal. | Float | Total |
Items - map | The total number of map items in Portal. | Float | Total |
Items - org | The total number of organization items in Portal. | Float | Total |
Items - private | The total number of private items in Portal. | Float | Total |
Items - public | The total number of public items in Portal. | Float | Total |
Items - scene | The total number of scene items in Portal. | Float | Total |
Items - shared | The total number of shared items in Portal. | Float | Total |
Items - tool | The total number of tool items in Portal. | Float | Total |
Users | The total number of users in Portal. | Float | Total |
Users - active | The total number of users that signed in to Portal within the past month. | ||
Users - creator | The total number of the Creator user type in Portal. | Float | Total |
Users - editor | The total number of the Editor user type in Portal. | Float | Total |
Users - viewer | The total number of the Viewer user type in Portal. | Float | Total |
Users - field_worker | The total number of the Mobile Worker user type in Portal. | Float | Total |
Users - gis_advanced | The total number of the GIS Professional Advanced user type in Portal. | Float | Total |
Users - gis_basic | The total number of the GIS Professional Basic user type in Portal. | Float | Total |
Users - gis_standard | The total number of the GIS Professional Standard user type in Portal. | Float | Total |
Users - insight_analyst | The total number of the Insights Analyst users in Portal. | Float | Total |
Users - storyteller | The total number of the Storyteller user type in Portal. | Float | Total |
Default alert rules
The following table lists the default alert rules that are configured for Portal:
| Metric name | Aggregation | Operator | Info threshold | Warning threshold | Critical threshold | Samples |
|---|---|---|---|---|---|---|
Connectivity - <Discover observer r_id> | Average | Is less than | — | — | 100 | 2 |
Connectivity - <Health checks observer r_id> | Average | Is less than | — | — | 100 | 2 |
Connectivity - <Logs observer r_id> | Average | Is less than | — | — | 100 | 2 |
Connectivity - <Metrics observer r_id> | Average | Is less than | — | — | 100 | 2 |
Health Check Status - federation | Average | Is equal to | — | — | 0 | 1 |
Health Check Status - index | Average | Is equal to | — | — | 0 | 1 |
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.