AlexKirhenshtein: Text replacement - "^" to "{{deprecated}}"

2022-09-13T16:13:53Z

Text replacement - "^" to "{{deprecated}}"

← Older revision		Revision as of 16:13, 13 September 2022
Line 1:		Line 1:
	Information moved to documentation:		{{deprecated}}Information moved to documentation:

	https://www.netxms.org/documentation/adminguide/database-monitoring.html#oracle		https://www.netxms.org/documentation/adminguide/database-monitoring.html#oracle

TatjanaDubrovica: Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/adminguide/database-monitoring.html#oracle"

2017-11-24T14:43:11Z

Replaced content with "Information moved to documentation: https://www.netxms.org/documentation/adminguide/database-monitoring.html#oracle"

Show changes

Valentine: /* XML configuration */

2013-12-19T15:39:47Z

XML configuration

← Older revision		Revision as of 15:39, 19 December 2013
Line 52:		Line 52:
	\|-		\|-
	\| Password \|\| Database user password. \|\| ''empty''		\| Password \|\| Database user password. \|\| ''empty''
			\|-
			\| EncryptedPassword \|\| Database user password encrypted with nxencpasswd. \|\| ''empty''
	\|}		\|}


	== INI configuration ==		== INI configuration ==

Valentine: /* INI configuration */

2013-12-19T15:39:20Z

INI configuration

← Older revision		Revision as of 15:39, 19 December 2013
Line 84:		Line 84:
	\|-		\|-
	\| Password \|\| Database user password. \|\| ''empty''		\| Password \|\| Database user password. \|\| ''empty''
			\|-
			\| EncryptedPassword \|\| Database user password encrypted with nxencpasswd. \|\| ''empty''
	\|}		\|}


	= Provided Parameters =		= Provided Parameters =

Victor at 21:56, 25 November 2012

2012-11-25T21:56:28Z

Show changes

Victor at 21:43, 25 November 2012

2012-11-25T21:43:22Z

← Older revision		Revision as of 21:43, 25 November 2012
Line 56:		Line 56:

	== INI configuration ==		== INI configuration ==

			There is a sample Oracle subagent configuration file in INI format:

			<syntaxhighlight lang="ini">
			SubAgent = oracle.nsm

			*ORACLE
			ID = DB1
			TNSName = TEST
			Username = NXMONITOR
			Password = NXMONITOR
			</syntaxhighlight>

			You can specify only one database when using INI configuration format. If you need to monitor multiple databases from same agent, you should use configuration file in XML format.

			'''ORACLE''' section can contain the following parameters:

			{\| class="wikitable"
			\|-
			! Parameter !! Description !! Default value
			\|-
			\| ID \|\| Database identifier. It will be used to address this database in parameters. \|\| ''empty''
			\|-
			\| TNSName \|\| Database TNS name. This is a name for Oracle connect string as described in tnsnames.ora. It can also be instant client connection string. \|\| ''empty''
			\|-
			\| Username \|\| User name for connecting to database. \|\| ''empty''
			\|-
			\| Password \|\| Database user password. \|\| ''empty''
			\|}

Victor: Created page with "{{DISPLAYTITLE:Oracle Monitoring Subagent}} = Summary = NetXMS subagent for Oracle DBMS monitoring (further referred to as Oracle subagent) monitors one or more instances of O..."

2012-06-28T10:16:58Z

Created page with "{{DISPLAYTITLE:Oracle Monitoring Subagent}} = Summary = NetXMS subagent for Oracle DBMS monitoring (further referred to as Oracle subagent) monitors one or more instances of O..."

New page

{{DISPLAYTITLE:Oracle Monitoring Subagent}}
= Summary =
NetXMS subagent for Oracle DBMS monitoring (further referred to as Oracle subagent) monitors one or more instances of Oracle databases and reports various database-related parameters.

All parameters available from Oracle subagent gathered or calculated once per minute thus its recommended to set DCI poll interval for these items to 60 seconds or more. All parameters are obtained or derived from the data available in Oracle's data dictionary tables and views through regular select queries. Oracle subagent does not monitor any of the metrics related to lower level database layers, such as database processes. Monitoring of such parameters can be achieved through the standard NetXMS functionality.

= Configuration =

Subagent can be configured using XML configuration file (usually created as separate file in configuration include directory), or in simplified INI format, usually in main agent configuration file.

== XML configuration ==

There is a sample Oracle subagent configuration file in XML format:

<syntaxhighlight lang="xml">
<config>
<agent>
<subagent>oracle.nsm</subagent>
</agent>
<oracle>
<databases>
<database id="1">
<id>DB1</id>
<tnsname>TEST</tnsname>
<username>NXMONITOR</username>
<password>NXMONITOR</password>
</database>
<database id="2">
<id>DB2</id>
<tnsname>PROD</tnsname>
<username>NETXMS</username>
<password>PASSWORD</password>
</database>
</databases>
</oracle>
</config>
</syntaxhighlight>

You can specify multiple databases in the '''oracle''' section. Each database description must be surrounded by '''database''' tags with the '''id''' attribute. '''id''' can be any unique integer, it instructs the Oracle subagent about the order in which '''database''' sections will be processed.

Each database definition supports the following parameters:

{| class="wikitable"
|-
! Parameter !! Description !! Default value
|-
| Id || Database identifier. It will be used to address this database in parameters. || ''empty''
|-
| TnsName || Database TNS name. This is a name for Oracle connect string as described in tnsnames.ora. It can also be instant client connection string. || ''empty''
|-
| UserName || User name for connecting to database. || ''empty''
|-
| Password || Database user password. || ''empty''
|}

== INI configuration ==

= Provided Parameters =

The Oracle subagent declares and supports a number of Oracle.* DCI parameters. Almost all of them accept a database id (the one specified in “Id” tag in the subagent configuration file) as the only input parameter (with the exception of Oracle.TableSpaces.* which also take a tablespace name). The all supported DCIs are described below.

{| class="wikitable"
|-
! Parameter !! Argument(s) !! Data Type !! Description
|-
| Oracle.Cursors.Count(*) || Database ID || Integer || Number of opened cursors (system-wide)
|-
| Oracle.Sessions.Count(*) || Database ID || Integer || Number of sessions opened
|-
| Oracle.DBInfo.IsReachable(*) || Database ID || String || YES if the database is reachable, NO otherwise
|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.DBInfo.Name(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Database name

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.DBInfo.CreateDate(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Database creation date

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.DBInfo.LogMode(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Database log mode (e.g. noarchive)

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.DBInfo.OpenMode(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Database open mode (e.g. read-only)

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.TableSpaces.Status(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id, tablespace name

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Status for specific tablespace (e.g. offline)

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.TableSpaces.Type(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id, tablespace name

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Type for specific tablespace (e.g. temporary)

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.TableSpaces.UsedPct(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id, tablespace name

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Percentage of space used for specific tablespace

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Instance.Version(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Version of Oracle DBMS

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Instance.Status(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Instance status (e.g. open, mounted)

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Instance.ArchiverStatus(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Archiver status (e.g. stopped)

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Instance.ShutdownPending(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Indicates whether a shutdown action is pending at the moment

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.TSOffCount(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of offline tablespaces

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.DFOffCount(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of offline datafiles

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.FullSegmentsCount(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of segments that cannot extend

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.RBSegsNotOnlineCount(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of rollback segments not online

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.AutoArchivingOff(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Archive logs enabled but auto archiving is off.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.DatafilesNeedMediaRecovery(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of datafiles that need media recovery

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.CriticalStats.FailedJobs(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of failed jobs.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Dual.ExcessRows(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Excessive rows in DUAL. The parameter returns 1 if there are more than 1 record in DUAL, 0 otherwise.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.PhysReads(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of physical reads

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.LogicReads(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of logical reads

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.CacheHitRatio(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Data buffer cache hit ratio

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.LibCacheHitRatio(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Library cache hit ratio

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.DictCacheHitRatio(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Dictionary cache hit ratio

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.RollbackWaitRatio(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Rollback wait ratio. A percentage of delays during the access to rollback segments.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.MemorySortRatio(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| PGA memory sort ratio. A percentage of sort operations performed in memory.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.DispatcherWorkload(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_STRING

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Dispatcher workload. A percentage of time dispatchers are busy.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Performance.FreeSharedPool(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Free space in shared pool in bytes.

|}

{| style="border-spacing:0;"
| colspan="2" style="border:none;padding:0.097cm;"| '''Oracle.Objects.InvalidCount(*)'''

|-
| style="border:none;padding:0.097cm;"| ''Input''
| style="border:none;padding:0.097cm;"| Database id

|-
| style="border:none;padding:0.097cm;"| ''Return type''
| style="border:none;padding:0.097cm;"| DCI_DT_INT64

|-
| style="border:none;padding:0.097cm;"| ''Description''
| style="border:none;padding:0.097cm;"| Number of invalid objects in the database.

|}

= Oracle configuration =

An Oracle user must have the role '''select_catalog_role''' assigned.

Required rights can be assigned to user with the following query:

grant select_catalog_role to user;

Where ''user'' is the user configured in Oracle subagent for database access.