Register SQL Server databases

You can register databases and geodatabases in Microsoft SQL Server to collect metrics and attribute information.

Prerequisites for monitoring

The following prerequisites are necessary for monitoring databases and geodatabases in SQL Server:

• ArcGIS Monitor Agent must be installed on a machine that has access to the SQL Server machine and must be registered with ArcGIS Monitor Server.

  When access to the SQL Server machine is available, it is recommended that you install Monitor Agent on that machine to collect operating system metrics.

• The Microsoft SQL Server versions listed below are supported for monitoring. The specific versions listed are the minimum certified versions. SQL Server service packs and cumulative updates on these versions are supported but not certified unless otherwise stated.
  • Microsoft SQL Server 2022 (64 bit)
  • Microsoft SQL Server 2019 (64 bit)
  • Microsoft SQL Server 2017 (64 bit)

  Note:

  Client drivers are included with the Monitor software.

• The database instance must have the TCP/IP protocol enabled.
• The firewall must allow communication between Monitor Agent and the SQL Server machine on port 1433.

  Note:

  If SQL Server is configured to run on a different port, communication must be allowed on that port instead.

• A SQL Server-authenticated user account must be used to register the database for monitoring and must be mapped to the database and be granted the View server state permission on the database instance. To monitor a geodatabase, the SQL Server user account's default schema must be the same schema in which the geodatabase system tables are stored.

Register SQL Server databases for monitoring

You must be assigned the Administrator or Manager role to register components.

To register databases and geodatabases in SQL Server, complete the following steps:

1. Access ArcGIS Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears with registered components listed alphabetically by 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 Monitor Agent machine where the component is installed, and click Next.

   If Monitor Agent cannot be installed on the machine, choose a Monitor Agent machine that has access to the database instead.

   The Component type page appears.

5. Under Database, choose SQL Server, and click Next.

   The Component details page appears.

6. Provide a name for the component in the Component name text box.
7. Optionally, provide a description for the component in the Description text box.
8. 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.

9. Click Next.

   The Connection page appears.

10. Provide the fully qualified domain name or IP address and port number of the database instance that you want to register in the Address text box.

    The default port number for SQL Server is 1433.

11. Provide 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. If the database requires encrypted connections, check the Require encryption check box.
14. 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 table describes the observers that collect attribute and metric data:

Observer name	Description
Inventory - Database MSSQL	This observer scans for changes and manages attribute data across the registered SQL Server database. It also detects enterprise geodatabase schemas to enable related metrics. The default interval for this observer is 10 minutes; however, you can configure it to run at longer intervals since changes to the database configuration are typically infrequent.
Metrics - Database MSSQL	This observer collects metric data across the registered SQL Server database. If no enterprise geodatabase schema is detected by the Inventory observer, no geodatabase-related metrics are collected. The default interval for this observer is 1 minute; however, you can configure it to run at longer intervals since significant database variations are typically infrequent.

Collected attributes

The subsections below describe the attributes that are collected for registered databases and geodatabases in SQL Server.

Database attributes

The following table lists the attributes that are collected for databases in SQL Server:

Attribute name	Description	Data type
Connections max	The maximum number of connections	Integer
Last backup at	The date and time the database was last backed up	Datetime
Memory total	The total amount of physical memory for the database instance	Float
Started at	The last start time of the database instance	Datetime
System mode	Specifies the state of the system as it is configured in SQL Server: Read Read Write	String
UTC offset	The UTC time zone offset for the database instance	Integer
Version	The software version of the SQL Server instance	String

Geodatabase attributes

The following table lists the attribute that is collected for geodatabases in SQL Server:

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

Geodatabase dataset attributes

The following table lists the attributes that are collected for geodatabase datasets:

Attribute name	Description	Data type
Geometry type	Specifies the geometry type of the dataset: Line Point Polygon - (None)	String
Is archived	Specifies whether the dataset is archived: No Yes	String
Versioned type	Specifies the dataset's versioned type: Branched Traditional - (None)	String

Collected metrics

The subsections below describe the metrics that are collected for registered databases and geodatabases in SQL Server.

Database metrics

The following table lists the metrics that are collected for databases in SQL Server:

Metric name	Description	Data type	Unit
Cache Hit	The percentage of requests served from the cache, as opposed to requests served from disk	Float	Percent
Connectivity	The agent's ability to successfully connect to the component	Float	Percent
Database Connections	The total number of database connections in use	Float	Total
Database Connections Utilized	The proportion of database connections in use	Float	Percent
Database Sessions	The number of open sessions in the database	Float	Total
Open Cursors	The number of open cursors in the database	Float	Total
Storage Used	The total amount of storage used	Float	Total

Geodatabase metrics

The following table lists the metrics that are collected for geodatabases in SQL Server:

Metric name	Description	Data type	Unit
Datasets	The total number of datasets	Float	Total
GDB Branch Version Conflicts	The total number of branch version conflicts in the geodatabase	Float	Total
GDB Branch Version Locks	The total number of locks on branch versions in the geodatabase	Float	Total
GDB Branch Versions	The total number of branch versions in the geodatabase	Float	Total
GDB Connections	The total number of active connections to the geodatabase	Float	Total
GDB Connections - editors	The total number of active editor connections to the geodatabase	Float	Total
GDB Connections - viewers	The total number of active viewer connections to the geodatabase	Float	Total
GDB Default Version Depth	The depth in the state tree of the default version	Float	Total
GDB Shared Locks	The total number of shared table locks in the geodatabase	Float	Total
GDB State Lineages	The total number of edits in the geodatabase for datasets that use traditional versioning	Float	Total
GDB Version States	The total number of states in the geodatabase for datasets that use traditional versioning	Float	Total
GDB Versions	The total number of versions in the geodatabase that use traditional versioning	Float	Total
Rows Total	The total number of rows	Float	Total
Storage Used	The total amount of storage used	Float	Total

Geodatabase dataset metrics

The following table lists the metrics that are collected for geodatabase datasets in Oracle:

Metric name	Description	Data type	Unit
Rows Total	The total number of rows	Float	Total
Storage Used	The total amount of storage used	Float	Total

Note:

To minimize performance impacts on monitored geodatabases, Monitor uses the database's statistics capability to collect dataset metrics. The accuracy of the metrics may diverge as statistics become obsolete and need to be recalculated.

Default alert rules

The following table lists the default alert rules that are configured for databases in SQL Server:

Metric name	Aggregation	Operator	Info threshold	Warning threshold	Critical threshold	Samples
Connectivity	Average	Is less than	—	—	100	2
Cache Hit	Average	Is less than	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 configured default alert rules for the Monitor deployment, the values for the rules above may vary.