Register ArcGIS Data Store

You can register ArcGIS Data Store relational data stores to collect metrics and attribute information.

Prerequisites for monitoring

The following prerequisites are necessary for monitoring Data Store:

• ArcGIS Monitor Agent must be installed on the Data Store machine and must be registered with ArcGIS Monitor Server.

  When monitoring high availability deployments, it is recommended that you install Monitor Agent on both relational data store machines in the deployment. This ensures continuous monitoring in the event of a machine failure and provides host metrics for each machine in the deployment.

• Data Store must be running on ArcGIS Enterprise version 10.7.1 or later.

Obtain the Database Admin User credentials

The Database Admin User credentials are required to register a relational data store.

To obtain the credentials, complete the following steps:

1. Sign in to the Data Store host machine as an administrator.

   Note:

   The account must be a member of the Windows Administrator group.

2. Open a command prompt window with Administrative privileges.

   Note:

   You must open the command prompt with the Run as Administrator option to use the Data Store utilities.

3. Run the command below and record the Database Admin User credentials.

   <ArcGIS Data Store installation location>\DataStore\tools\listadminusers.bat

   The following is an example:

   C:\Program Files\ArcGIS\DataStore\tools\listadminusers.bat

Register Data Store for monitoring

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

To register a Data Store component, complete the following steps:

1. Access ArcGIS Monitor if necessary.

   The Home page appears.

2. Click Monitoring.

   The Monitoring page appears. Registered components are listed alphabetically by component 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.

   The Component type page appears.

5. Under ArcGIS, choose ArcGIS Data Store 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 Database Admin User credentials in the Username and Password text boxes.

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 Data Store attribute and metric data:

Observer name	Description
Inventory - ArcGIS Data Store	This observer scans for changes and manages attribute data across Data Store and its underlying datasets. The default interval for this observer is 15 minutes; however, you can configure it to run at longer intervals since changes to the site configuration are typically infrequent.
Metrics - ArcGIS Data Store	This observer collects metric data across Data Store and its underlying datasets. The default interval for this observer is 5 minutes; however, you can configure it to run at shorter intervals to retrieve data more frequently.

Collected attributes

The subsections below describe the attributes that are collected for Data Store and its underlying datasets.

Data Store

The following table lists the attributes that are collected for Data Store:

Attribute name	Description	Data type
Connections max	The maximum number of connections that can be open at one time	Integer
Last backup at	The last time Data Store was backed up	Datetime
Memory total	The total amount of memory (RAM) allocated to Data Store	Integer
Started at	The date and time Data Store was last started	Datetime
System mode	Specifies the mode of the system: read read/write	String
System state	Specifies the state of the system as it is configured in Data Store: started stopped
Version	The software version of Data Store	String

Data Store datasets

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

Attribute name	Description	Data type
Geometry type	Specifies the geometry type of the dataset: point line polygon	String
Versioned type	Specifies the dataset's versioned type: version branch - (None)	String
Is archived	Specifies whether the dataset is archived: yes no	String
Last modified at	The data and time the dataset was last modified	Datetime

Collected metrics

The subsections below describe the metrics that are collected for Data Store and its underlying datasets.

Data Store metrics

The following table lists the metrics that are collected for Data Store:

Metric name	Description	Data type	Unit
Cache Hit	The percentage of requests served from the cache, as opposed to requests served from disk.	Float	Percentage
Connectivity	The agent's ability to successfully connect to the component.	Float	Percent
Database Connections	The total number of active connections.	Float	Percent
Database Connections Utilized	The proportion of allocated database connections in use. Values approaching 100 may indicate that the current allocation is insufficient.	Float	Percent
Datasets	The total number of datasets.	Float	Total
Open Cursors	The number of open cursors in the database.	Float	Total
Rows Total	The total number of rows in all tables in the database.	Float	Total
Storage Used	The total amount of storage used by all tables in the database.	Float	Total

Data Store dataset metrics

The following table lists the metrics that are collected for Data Store datasets:

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

Default alert rules

The following table lists the default alert rules that are configured for Data Store:

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.