Register Portal for ArcGIS
You can register Portal for ArcGIS to collect system health and performance metrics.
Prerequisites for monitoring
The following prerequisites apply to monitoring Portal:
Install ArcGIS Monitor Agent on the Portal machine and register it with ArcGIS Monitor Server.
When monitoring high-availability deployments, install Monitor Agent on all Portal machines to ensure continuous monitoring in the event of a machine failure and to provide host metrics for each machine.
Monitor supports the following versions of Portal. The specific versions listed are the minimum certified versions. Monitor supports newer minor versions, but these versions are not certified unless otherwise stated.
Portal for ArcGIS 12.1
Portal for ArcGIS 12.0
Portal for ArcGIS 11.5
Portal for ArcGIS 11.3
Portal for ArcGIS 11.1
You must use the primary Portal administrator account or an equivalent account assigned the default Administrator role to register Portal for monitoring.
Register Portal for monitoring
You must be assigned the Administrator or Manager role to register components.
To register a Portal for ArcGIS component, complete the following steps:
Access ArcGIS Monitor if necessary.
The Home page appears.
Click Monitoring.
The Monitoring page appears with registered components listed alphabetically by name.
Click Register component.
The Register component wizard appears.
Note:
If you don't have sufficient privileges, Register component is not available.
Choose the Monitor Agent machine where the component is installed, and click Next.
The Component type page appears.
Under ArcGIS, choose Portal for ArcGIS, and click Next.
The Component details page appears.
- Provide a name for the component in the Component name text box.
- Optionally, provide 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:
Provide the name of a label in the Enter label name text box to search for a specific label. If the label doesn't exist, click Create new label to add the label and apply it to the component.
Click Next.
The Connection page appears.
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 collect Portal attribute and metric data:
|
Observer name |
Description |
|---|---|
|
Health Check - Portal for ArcGIS |
This 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. |
|
Inventory - Portal for ArcGIS |
This observer scans for changes and manages attribute data and component relationships across Portal and its items. The default interval for this observer is 5 minutes; however, you can configure it to run at longer intervals since changes to Portal are typically infrequent. |
|
Logs - Portal for ArcGIS |
This 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 - Portal for ArcGIS |
This 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. |
|
Sessions - Portal for ArcGIS |
After Portal for ArcGIS is registered with Monitor, restart Portal for ArcGIS for this observer to scan the logs for app usage. The default interval for this observer is 1 minute to retrieve data frequently. Do not run this observer at longer intervals. |
Collected attributes
The following subsections describe the attributes that are collected for Portal and portal items.
Portal
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 |
Web applications
The following table lists the attributes that are collected for web applications:
|
Attribute name |
Description |
Data type |
|---|---|---|
|
Content status |
The content status of the web application |
String |
|
Last modified at |
The data and time the web application was last modified |
Datetime |
|
Owner |
The owner of the web application |
String |
|
Sharing level |
The shared access level of the web application |
String |
|
System created at |
The date and time the web application was created |
Datetime |
Web maps
The following table lists the attributes that are collected for web maps:
|
Attribute name |
Description |
Data type |
|---|---|---|
|
Content status |
The content status of the web map |
String |
|
Last modified at |
The data and time the web map was last modified |
Datetime |
|
Owner |
The owner of the web map |
String |
|
Sharing level |
The shared access level of the web map |
String |
|
System created at |
The date and time the web map was created |
Datetime |
Collected metrics
The following subsections describe the metrics collected for Portal and portal items.
Portal for ArcGIS
The following table lists the metrics collected for Portal for ArcGIS:
|
Metric name |
Description |
Data type |
Unit |
|---|---|---|---|
|
Active Sessions |
The total number of active sessions over the interval for all apps in the portal. |
Float |
Total |
|
Active Session Time |
The duration of all active sessions in all of the apps in the portal over the interval. |
Float |
Time |
|
Connectivity |
The agent's ability to successfully connect to the component. |
Float |
Percent |
|
Groups |
The total number of groups in Portal. |
Float |
Total |
|
Groups Access - private |
The total number of private groups in Portal. |
Float |
Total |
|
Groups Access - public |
The total number of public groups in Portal. |
Float |
Total |
|
Groups Access - org |
The total number of organization groups in Portal. |
Float |
Total |
|
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 |
|
Items |
The total number of items in Portal. |
Float |
Total |
|
Items Type - app |
The total number of app items in Portal. |
Float |
Total |
|
Items Type - data_store |
The total number of ArcGIS Data Store items in Portal. |
Float |
Total |
|
Items Type - file |
The total number of file items in Portal. |
Float |
Total |
|
Items Type - insight |
The total number of ArcGIS Insights items in Portal. |
Float |
Total |
|
Items Type - layer |
The total number of layer items in Portal. |
Float |
Total |
|
Items Type - map |
The total number of map items in Portal. |
Float |
Total |
|
Items Type - org |
The total number of organization items in Portal. |
Float |
Total |
|
Items Type - private |
The total number of private items in Portal. |
Float |
Total |
|
Items Type - public |
The total number of public items in Portal. |
Float |
Total |
|
Items Type - scene |
The total number of scene items in Portal. |
Float |
Total |
|
Items Type - shared |
The total number of shared items in Portal. |
Float |
Total |
|
Items Type - tool |
The total number of tool items in Portal. |
Float |
Total |
|
Licenses Used - creator |
The total number of the Creator user type in Portal. |
Float |
Total |
|
Licenses Used - editor |
The total number of the Contributor user type in Portal. |
Float |
Total |
|
Licenses Used - field_worker |
The total number of the Mobile Worker user type in Portal. |
Float |
Total |
|
Licenses Used - gis_advanced |
The total number of the Professional Plus user type in Portal. |
Float |
Total |
|
Licenses Used - gis_basic |
The total number of the Creator user type in Portal. |
Float |
Total |
|
Licenses Used - gis_standard |
The total number of the Professional user type in Portal. |
Float |
Total |
|
Licenses Used - insight_analyst |
The total number of the Insights Analyst user type in Portal. |
Float |
Total |
|
Licenses Used - storyteller |
The total number of the Storyteller user type in Portal. |
Float |
Total |
|
Licenses Used - viewer |
The total number of the Viewer user type in Portal. |
Float |
Total |
|
Users |
The total number of users in Portal. |
Float |
Total |
|
Users Active - last day |
The total number of users that signed in to Portal within the past 24 hours. |
Float |
Total |
|
Users Active - last hour |
The total number of users that signed in to Portal within the last hour. |
Float |
Total |
|
Users Active - last month |
The total number of users that signed in to Portal within the last 30-day period. |
Float |
Total |
|
Users Active - last week |
The total number of users that signed in to Portal within the past week. |
Float |
Total |
|
Users Active - never |
The total number of users that have never signed in to Portal. |
Float |
Total |
Web applications
The following table lists the metrics collected for web apps:
|
Metric name |
Description |
Data type |
Unit |
|---|---|---|---|
|
Active Sessions |
The total number of active sessions over the interval for the specific web app. |
Float |
Total |
|
Active Session Time |
The duration of all active sessions in the specific web app over the interval. |
Float |
Time |
Web maps
The following table lists the metrics collected for web maps:
|
Metric name |
Description |
Data type |
Unit |
|---|---|---|---|
|
Active Sessions |
The total number of active sessions over the interval for the specific web map. |
Float |
Total |
|
Active Session Time |
The duration of all active sessions in the specific web map over the interval. |
Float |
Time |
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 |
Average |
Is less than |
N/A |
N/A |
100 |
2 |
|
Health Check Status - federation |
Average |
Is equal to |
N/A |
N/A |
0 |
1 |
|
Health Check Status - index |
Average |
Is equal to |
N/A |
N/A |
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 configured default alert rules for the Monitor deployment, the values for the rules above may vary.
Component relationships
The following subsections describe relationships that automatically form with registered Portal for ArcGIS components.
Web application
The portal inventory observer detects web applications created in portal, and Monitor forms individual relationships between the Portal for ArcGIS component and its web applications. The observer also detects and manages relationships between web applications and their configured web maps and related services from ArcGIS Server and ArcGIS Online components that are registered for monitoring.
Note:
If the Portal for ArcGIS component is unregistered in Monitor, its web applications are also unregistered.
Web map
The portal inventory observer detects web maps created in portal, and Monitor forms individual relationships between the Portal for ArcGIS component and its web maps. The portal inventory observer also manages relationships between web maps and web applications and related services from ArcGIS Server and ArcGIS Online components that are registered for monitoring.
Note:
If the Portal for ArcGIS component is unregistered in Monitor, its web maps are also unregistered.
Host
A host's inventory observer detects instances of Portal for ArcGIS running on the host machine, and Monitor forms a relationship between the host component and the registered 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 relationships to be formed between the individual Portal for ArcGIS components and participating host machines.
ArcGIS Server
The portal inventory observer detects federated ArcGIS Server sites and forms individual relationships between each registered ArcGIS Server component and Portal for ArcGIS component.
Note:
If a federated ArcGIS Server site is removed from the portal, the relationship is removed, but monitoring of the ArcGIS Server component continues.
Portal usage metrics
The following subsections describe metrics related to usage metrics for apps in Portal for ArcGIS. The first time you collect usage metrics, restart Portal for ArcGIS and ArcGIS Server to accurately measure usage in apps with the session observers. ArcGIS Monitor supports usage metrics for the following portal apps:
ArcGIS StoryMaps
ArcGIS Instant Apps
ArcGIS Dashboards
ArcGIS Experience Builder
Map Viewer
Note:
Usage metrics are collected only when users access the app directly. If a custom dashboard is viewed through an embedded context (such as within a story), that activity is not included in the collected usage data.
Active Sessions
The Portal for ArcGIS session observer scans logs to measure the number of active sessions interacting with the app during a specific time period. A session is a single continuous period of time during which a user actively interacts with an app. The session becomes inactive after 5 minutes of inactivity in the app.
For example, if a GIS administrator observes a spike from 50 to 500 active sessions, this indicates heavy real-time demand and allows administrators to proactively scale the GIS systems to maintain performance and availability.
Active Session Time
The session observer for the Portal for ArcGIS calculates the average length of time users are active in an app during their session.
For example, a GIS administrator can use Active Session Time to gauge user engagement and the value of the app.