Register PostgreSQL databases

You can register databases and geodatabases in PostgreSQL to collect metrics and attribute information.

Prerequisites for monitoring

The following is a list of prerequisites for monitoring databases and geodatabases in PostgreSQL:

• Your database instance must be running PostgreSQL 10.17 or later.
• Your firewall must allow communication between the PostgreSQL instance and the ArcGIS Monitor machine to which it will be registered on port 5432.

  Note:

  If the PostgreSQL instance is configured to run on a different port, communication must instead be allowed on that port.

• The role (user account) that you use to register the database must be assigned the PostgreSQL LOGIN attribute.

Register databases for monitoring

You must be assigned the Administrator or Manager role to register components. Complete these steps to register databases and geodatabases in PostgreSQL:

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 PostgreSQL under Database 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 fully qualified domain name and port number or IP address and port number of the database instance that you want to register in the Address text box.

    Tip:

    The default port number for PostgreSQL is 5432.

11. Type the name of the database that you want to register in the Database text box.
12. Provide the credentials for the database in the Username and Password text boxes.
13. 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 ArcGIS software, must be registered individually to enable monitoring.

Observers

The following is a list of observers that are responsible for collecting attribute and metric data:

Observer name	Description
Discover	The Discover observer scans for changes and manages attribute data across the registered PostgreSQL database. It also detects enterprise geodatabase schemas to enable related metrics. The default interval for this observer is set to 5 minutes; however, it can be configured to run at longer intervals since changes to the underlying database configuration are expected to be infrequent.
Metrics	The Metrics observer collects metric data across the registered PostgreSQL database. If an enterprise geodatabase schema is not detected by the Discover observer, geodatabase-related metrics are not collected. The default interval for this observer is set to 5 minutes as significant database variations are expected to be infrequent.

Collected attributes

The following sections list the attributes that are collected for registered databases and geodatabases in PostgreSQL.

Database attributes

The following is a list of attributes that are collected for databases in PostgreSQL:

Attribute name	Description	Data type
Memory Total	The database instance's total amount of physical memory.	Float
Started At	The database instance's last start time.	Datetime
UTC Offset	The database instance's UTC time zone offset.	Integer
Version	The software version of the PostgreSQL instance.	String

Geodatabase attributes

The following is a list of attributes that are collected for geodatabases in PostgreSQL:

Attribute name	Description	Data type
Geodatabase Version	The version of the enterprise geodatabase.	String

Collected metrics

The following sections list the metrics that are collected for registered databases and geodatabases in PostgreSQL.

Database metrics

The following is a list of metrics that are collected for databases in PostgreSQL:

Metric name	Description	Data type
Cache Hit	The percentage of requests served from the cache, as opposed to requests served from disk.	Float
Database Sessions	The number of open sessions in the database.	Float
Open Cursors	The number of open cursors in the database.	Float

Geodatabase metrics

The following is a list of metrics that are collected for geodatabases in PostgreSQL:

Metric name	Description	Data type
GDB Branch Version Conflicts	The total number of branch version conflicts in the geodatabase.	Float
GDB Branch Version Locks	The total number of locks on branch versions in the geodatabase.	Float
GDB Branch Versions	The total number of branch versions in the geodatabase.	Float
GDB Connections	The total number of active connections to the geodatabase.	Float
GDB Default Version Depth	The depth in the state tree of the default version.	Float
GDB Shared Locks	The total number of shared table locks in the geodatabase.	Float
GDB State Lineages	The total number of edits in the geodatabase for datasets that use traditional versioning.	Float
GDB Version States	The total number of states in the geodatabase for datasets that use traditional versioning.	Float
GDB Versions	The total number of versions in the geodatabase that use traditional versioning.	Float

Default alert rules

The following is a list of default alert rules that are configured for databases in PostgreSQL.

Metric name	Aggregation	Operator	Info threshold	Warning threshold	Critical threshold	Samples
Cache Hit	Average	Is less than	90	—	—	3