Oracle Database monitoring configuration

After you define the scope of your configuration, you need to identify the databases you'd like to collect data from and identify the ActiveGates that will execute the extension and connect to your devices.

Make sure that all the ActiveGates from the ActiveGate group you'll define as the scope can connect to a respective data source. You can assign an ActiveGate to a group during or after installation. For more information, see ActiveGate group.

The monitoring configuration is a JSON payload defining the connection details, credentials, and feature sets that you want to monitor. For details, see Start monitoring.

Example payload to activate an Oracle SQL extension:

[
  {
    "value": {
      "enabled": true,
      "description": "My Oracle SQL extension",
      "version": "0.1.1",
      "featureSets": [
        "io",
        "cpu",
      ],
      "sqlOracleRemote": {
        "licenseAccepted": true,
        "endpoints": [
          {
            "host": "sqlserver.org",
            "port": 1521,
            "databaseIdentifier": "serviceName",
            "authentication": {
              "scheme": "basic",
              "username": "admin",
              "password": "password"
            },
            "serviceName": "some-serviceName"
            "ssl": false
          }
        ]
      }
    },
    "scope": "ag_group-default"
  }
]

When you have your initial extension YAML ready, package it, sign it, and upload it to your Dynatrace environment. For details, see Manage extension lifecyle.

The Dynatrace Hub-based extension activation wizard contains a dynamically updated JSON payload with your monitoring configuration

You can also use the Dynatrace API to download the schema for your extension that will help you create the JSON payload for your monitoring configuration.

Use the GET an extension schema endpoint.

Issue the following request:

curl -X GET "{env-id}.live.dynatrace.com/api/v2/extensions/{extension-name}/{extension-version}/schema" \
   -H "accept: application/json; charset=utf-8" \
   -H "Authorization: Api-Token {api-token}"

Make sure to replace {extension-name} and {extension-version} with values from your extension YAML file. A successful call returns the JSON schema.

Scope

Note that each ActiveGate host running your extension needs the root certificate to verify the authenticity of your extension. For more information, see Sign extension.

The scope is an ActiveGate group that will execute the extension. Only one ActiveGate from the group will run this monitoring configuration. If you plan to use a single ActiveGate, assign it to a dedicated group. You can assign an ActiveGate to a group during or after installation. For more information, see ActiveGate group.

Use the following format when defining the ActiveGate group:

"scope": "ag_group-<ActiveGate-group-name>",

Replace <ActiveGate-group-name> with the actual name.

Version

Version of this monitoring configuration. Note that a single extension can run multiple monitoring configurations.

Description

Human-readable description of the specifics of this monitoring configuration.

Enabled

If set to true, the configuration is active and Dynatrace starts monitoring immediately.

Endpoints

You can define up to 20,000 endpoints in a single monitoring configuration in the SQLOracleRemote section.

"sqlOracleRemote": {
    "licenseAccepted": true,
    "endpoints": [
      {
        "host": "sqlserver.org",
        "port": 1521,
        "databaseIdentifier": "serviceName",
        "authentication": {
          "scheme": "basic",
          "username": "admin",
          "password": "password"
        },
        "serviceName": "some-serviceName"
        "ssl": false
      }
    ]
  }
}

Oracle JDBC Driver

The Oracle SQL data source requires the Oracle JDBC driver distributed by Dynatrace. By setting the licenceAccepted property to true, you indicate that you have read and accepted the Dynatrace redistribution license agreement for Oracle JDBC Driver.

To define an Oracle Database server, add the following details in the endpoints section:

Authentication

Authentication details passed to the Dynatrace API when activating monitoring configuration are obfuscated and it's impossible to retrieve them.

Credential vault

The credential vault authentication type provides a more secure approach to using extensions by securely storing and managing user credentials. To use this, you must be the owner of the credentials and have a credential vault that meets the following criteria:

"authentication": {
   "scheme": "basic",
   "useCredentialVault": true,
   "credentialVaultId": "some-credential-vault-id"
}

Feature sets

Add a list of feature sets you want to monitor. To report all feature sets, add all.

"featureSets": [
  "cpu",
  "io"
  ]

TopN

The feature set topN enables monitoring of the most resource-intensive queries. Enabled by default.

"featureSets": [
  "topN"
  ]

This groups topN queries by an entity. The queries are displayed on the event page and on a unified analysis page for the Oracle server entity.

Multitenancy

The feature set multitenancy enhances the monitoring capabilities by querying and retrieving information about Container Databases (CDBs), Pluggable Databases (PDBs), and the services associated with the specified database in the monitoring configuration.

"featureSets": [
  "multitenancy"
  ]

Heavy query timeout

ActiveGate version 1.275+

Add the long-running-query-timeout parameter to configure the timeout duration for long-running SQL queries. This parameter is optional, and if not set, the default timeout of 10 seconds is applied.

"vars": {
  "long-running-query-timeout": null
}

SSL

ActiveGate version 1.251+

Enable SSL to force the data source to verify the server certificate and use SSL encryption instead of native encryption.

"ssl": true

Enable SSL without a local truststore

When SSL is enabled and the server's certificate chain is publicly verifiable (for example, issued by Azure or other well-known CAs), there's no need to manually create a truststore. The system will automatically trust the server's certificate based on the trusted CAs in the environment.

However, if you need to use a local truststore for certificates not globally recognized or for additional security measures

Validate SSL certificates

ActiveGate version 1.269+

The certificate is additionally validated with hostname, which means that the domain from the certificate must match the one from the endpoint passed in the monitoring configuration.

Enable this option when connecting to databases using custom certificates.

"validateCertificates": true

Resource consumption

Resource consumption depends on the number of Oracle endpoints. The first endpoint consumes 110 MB of RAM and 0.1%–0.5% of CPU. Every following endpoint consumes 0.5–1.0 MB of RAM and ~0.01% of CPU.