Register Oracle databases
You can register databases and geodatabases in Oracle to collect metrics and attribute information.
Prerequisites for monitoring
The following prerequisites apply to monitoring databases and geodatabases in Oracle:
Install ArcGIS Monitor Agent on a machine that has access to the Oracle machine and register it with ArcGIS Monitor Server.
If the Oracle machine is accessible, install Monitor Agent on that machine to collect operating system metrics.
The following Oracle versions are supported for monitoring. The specific versions listed are the minimum certified versions. Newer patch updates to these versions are supported but are not certified unless otherwise stated.
Oracle 26ai 23.26.1.0.0 (Linux only)
Oracle 19c (64 bit) 19.3.0.0
Note:
The Monitor software includes client drivers.
If Monitor Agent is not installed on the Oracle machine, configure the firewall to allow communication between Oracle and the ArcGIS Monitor machine on port 1521.
Note:
If Oracle runs on a different port, allow communication on that port instead.
Add the ST_Geometry type to the Oracle database to enable monitoring.
The Oracle user account that you use to register the database for monitoring must have the following read permissions to collect attribute and metric data:
SDE system tables (if applicable)
v$instance
v$session
v$sesstat
v$sga
v$statname
v$sysmetric_history
DUAL
Configure the Oracle user account to use password version 11G or later.
Tip:
To view password verifiers for
DBA_USERS, run the following query:SELECT USERNAME, PASSWORD_VERSIONS FROM DBA_USERS;.Caution:
Grant only read permissions to the Oracle user account to prevent custom database queries from altering the database.
Register databases for monitoring
You must have the Administrator or Manager role to register components.
To register databases and geodatabases in Oracle, 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.
If you cannot install Monitor Agent on the machine, choose a Monitor Agent machine that has access to the database instead.
The Component type page appears.
Under Database, choose Oracle, 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 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 Oracle is 1521.
Provide the service name of the database that you want to register in the Service name text box.
Provide the credentials for the database in the Username and Password text boxes.
If the database requires encrypted connections, check the Require encryption check box.
Click Register component.
The component is added to the list of monitored components on the Monitoring page.
After you register a component, you can configure alert rules and add it to collections.
Note:
You must register other component types individually to enable monitoring, such as the enterprise GIS implementation's underlying hardware infrastructure and ArcGIS software.
Observers
The following table describes the observers that collect attribute and metric data:
|
Observer name |
Description |
|---|---|
|
Database Query |
This optional, user-configured observer runs an SQL query on the registered Oracle database and returns a single numeric value. |
|
Inventory - Database Oracle |
This observer scans for changes and manages attribute data and component relationships across the registered Oracle 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 Oracle |
This observer collects metric data across the registered Oracle database. If the Inventory observer does not detect an enterprise geodatabase schema, Monitor does not collect geodatabase-related metrics. 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 following subsections describe the attributes collected for registered databases and geodatabases in Oracle.
Database attributes
The following table lists the attributes that are collected for databases in Oracle:
|
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 system global area (SGA) 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 Oracle:
|
String |
|
UTC offset |
The UTC time zone offset for the database instance |
Integer |
|
Version |
The software version of the Oracle instance |
String |
Geodatabase attributes
The following table lists the attribute that is collected for geodatabases in Oracle:
|
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:
|
String |
|
Is archived |
Specifies whether the dataset is archived:
|
String |
|
Versioned type |
Specifies the dataset's versioned type:
|
String |
Collected metrics
The following subsections describe the metrics collected for registered databases and geodatabases in Oracle.
Database metrics
The following table lists the metrics that are collected for databases in Oracle:
|
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 Oracle:
|
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.
Optional metrics
The following table lists the optional metrics that you can collect by configuring the Database Query observer:
|
Metric name |
Description |
Data type |
Unit |
|---|---|---|---|
|
Database Query - <observer_name> |
The response of the SQL query |
Float |
Total |
Enable optional metrics
To enable optional metrics for Oracle databases and geodatabases, 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 component name.
Click the name of the Oracle database or geodatabase component for which you want to enable optional metrics.
The database's Overview page appears with its details and an overview of its metrics.
Tip:
Type a keyword in the Search by component name or address text box to search for specific components and subcomponents.
Click the Observers tab.
The Observers page appears.
Click Add observer.
The Add observer dialog box appears.
Choose Database Query, and click Next.
The Observer details page appears.
Provide a name for the observer in the Observer name text box.
The observer name identifies the observer, and all metric names include the observer name as a prefix. For example, if the observer name is Health Check, the metric names are <MetricName> - health_check.
Optionally, provide a description for the observer in the Description text box.
Click Next.
The Configuration page appears.
Click the Interval drop-down arrow, and choose an interval.
Provide an SQL query that returns a single numeric value in the Query text box.
The following is an example query that returns the number of days since the database was last backed up:
SELECT ROUND(SYSDATE - MAX(completion_time)) AS last_backup_days FROM v$backup_set WHERE backup_type IN ('I', 'D');Note:
The observer inherits the credentials of the associated Oracle database or geodatabase component.
Click Test to validate the SQL query.
The result of the test appears in the Results section.
Click Add observer.
The observer is added to the list of observers on the Observers page.
Note:
The Add observer button is only available when the SQL query test result is successful.
Optional metrics are collected and automatically appear in Monitor according to the observer's configured interval.
Default alert rules
The following table lists the default alert rules for Oracle databases:
|
Metric name |
Aggregation |
Operator |
Info threshold |
Warning threshold |
Critical threshold |
Samples |
|---|---|---|---|---|---|---|
|
Cache Hit |
Average |
Is less than |
90 |
— |
— |
3 |
|
Connectivity |
Average |
Is less than |
— |
— |
100 |
2 |
Note:
The default alert rules in the table above 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 the relationships formed with registered Oracle database components.
Geodatabase datasets
The inventory observer for Oracle databases detects only datasets in a geodatabase and forms individual relationships between the Oracle database component and its datasets. When registered with a monitored ArcGIS Server site, the ArcGIS Server inventory observer discovers and manages relationships between its services and the database's datasets.
Note:
If you unregister the Oracle component in Monitor, Monitor also unregisters the datasets in the component.
Host
A host's inventory observer detects instances of Oracle running on the host machine and forms a relationship between the host component and the registered Oracle database component.
Note:
Monitor cannot form host relationships for remotely monitored databases because the host is unavailable for monitoring.
ArcGIS Server
When you register an Oracle database with a monitored ArcGIS Server site, the ArcGIS Server inventory observer discovers and manages relationships between the ArcGIS Server site and the Oracle database component.
Note:
If you unregister the Oracle database component in Monitor, Monitor removes the relationship between the ArcGIS Server site and the Oracle database component.