## All options defined here are available to all instances.

#

init_config:

## @param min_collection_interval - int - optional - default:10

## Active session sampling interval in seconds

# min_collection_interval: <interval_in_seconds>

## @param propagate_agent_tags - boolean - optional - default: false

## Set to `true` to propagate the tags from `datadog.yaml` and the agent host tags to the check.

## When set to `true`, the tags from the agent host are added to the check's tags for all instances.

#

# propagate_agent_tags: false

## @param global_custom_queries - list of mappings - optional

## See `custom_queries` defined below.

##

## Global custom queries can be applied to all instances using the

## `use_global_custom_queries` setting at the instance level.

#

# global_custom_queries:

# - query: <QUERY>

# columns: <COLUMNS>

# tags: <TAGS>

#

## @param service - string - optional

## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.

##

#

# service: <SERVICE>

## Every instance is scheduled independent of the others.

#

instances:

## @param server - string - optional - default:1521

## Host and, optionally, port of your Oracle database instance.

## If a port is ommitted, a default port of 1521 will be used.

## If you use Oracle names resolution via tnsnamas.ora or ldap.ora,

## you must specify 'tns_alias' instead of 'server' and 'service_name'.

#

- server: <HOST> or server: <HOST>:<PORT>

## @param port - string - optional

## The port of your Oracle database. It overrides the port specified in 'server'

#

# port: <PORT>

## @param service_name - string - optional

## The Oracle CDB service name. To view the services available on your server,

## run the following query: `SELECT value FROM v$parameter WHERE name='service_names'`

#

# service_name: <SERVICE_NAME>

## @param tns_alias - string - optional

## The alias for the database connect string (stored in tnsnames.ora or in LDAP) to a CDB.

## It's an alternative to specifying 'server' and 'service_name'. 'tns_alias' requires

## an Oracle software installation.

#

# tns_alias: <TNS_ALIAS>

## @param tns_admin - string - optional

## The location of the Oracle client configuration files (sqlnet.ora, tnsnames.ora, ldap.ora).

## This configuration is required only when using Oracle instant client. Oracle instant client

## is reuquired when the 'tns_alias' is set. Alternatively, you can set the environment variable

## TNS_ADMIN before starting the Datadog agent.

#

# tns_admin: <TNS_ADMIN_DIR>

## @param protocol - string - optional - default: TCP

## The protocol to connect to the Oracle Database Server. Valid protocols include TCP and TCPS.

#

# protocol: TCP

## @param wallet - string - optional

## The directory containing Oracle wallet. Oracle wallet is used with TCPS protocol.

#

# wallet: <WALLET_DIR>>

## @param instant_client - boolean - optional

## DEPRECATED, use oracle_client instead

## Force using instant_client even when 'tns_alias' isn't used. This might be necessary

## for using some advanced Oracle SQLNet features which aren't supported by the

## Oracle driver for Go. If you specify 'tns_admin' the agent will automatically try

## to use instant client.

#

# instant_client: false

## @param oracle_client - boolean - optional

## Force using an external Oracle client even when `tns_alias` isn't set. This might be necessary

## for using some advanced Oracle SQLNet features which aren't supported by the

## Oracle driver for Go. If you specify 'tns_admin', the agent will automatically try

## to use an external client. For Linux, if you are using instant client, set

## the environment variable `LD_LIBRARY_PATH` for the Agent process. If you are using

## a client or server Oracle home, additionally set `ORACLE_HOME`.

#

# oracle_client: false

## @param username - string - required

## Username for the Datadog-Oracle server check user. The user has to exist in CDB.

#

# username: <USERNAME>

## @param password - string - required

## Password for the Datadog-Oracle check user.

#

# password: <PASSWORD>

## @param reported_hostname - string - optional

## Set the reported hostname for this instance. This value overrides the hostname detected by the Agent

#

# reported_hostname: <REPORTED_HOSTNAME>

## @param exclude_hostname - boolean - optional - default: false

## Omit the hostname from tags and events. This is useful when the database host is not monitored by an agent.

#

# exclude_hostname: false

## Controls how the database is identified. The default value is the resolved hostname for the instance,

## which respects the `reported_hostname` option.

##

## This value will be used as-is for the display name of the instance but will be normalized

## when applied as a tag. Please see https://docs.datadoghq.com/getting_started/tagging/ for

## more details on Datadog tag normalization.

#

# database_identifier:

## @param template - string - optional - default: $resolved_hostname

## The template to use for the database identifier. The default value is `$resolved_hostname`.

## You can use the following variables, prefixed by `$` in the template:

## - resolved_hostname: The resolved hostname of the instance, which respects the `reported_hostname` option.

## - server: The provided server of the instance.

## - port: The port number of the instance.

## - service_name: The provided service name of the instance.

## - cdb_name: The resolved CDB name of the instance.

## In addition, you can use any key from the `tags` section of the configuration.

#

# template: <DATABASE_IDENTIFIER_TEMPLATE>

## @param dbm - boolean - optional - default: false

## Set to `true` to enable Database Monitoring.

#

# dbm: false

## @param propagate_agent_tags - boolean - optional - default: false

## Set to `true` to propagate the tags from `datadog.yaml` and the agent host tags to the check.

## When set to `true`, the tags from the agent host are added to the check's tags for all instances.

## This option takes precedence over the `propagate_agent_tags` option in `init_config`.

#

# propagate_agent_tags: false

## @param tags - list of strings - optional

## A list of tags to attach to every metric and service check emitted by this instance.

##

## Learn more about tagging at https://docs.datadoghq.com/tagging

#

# tags:

# - <KEY_1>:<VALUE_1>

# - <KEY_2>:<VALUE_2>

## @param service - string - optional

## Attach the tag `service:<SERVICE>` to every metric, event, and service check emitted by this integration.

##

## Overrides any `service` defined in the `init_config` section.

#

# service: <SERVICE>

## Configure collection of query samples

#

# query_samples:

## @param enabled - boolean - optional - default: true

## Enable collection of query samples. Requires `dbm: true`.

#

# enabled: true

## @param active_session_history - boolean - optional - default: false

## Collect activity samples from `v$active_session_history` instead of the Agent performing sampling.

## WARNING: Querying `v$active_session_history` requires optional Oracle licences and may result in additional costs if enabled.

#

# active_session_history: false

## Configure collection of query metrics

#

# query_metrics:

## @param enabled - boolean - optional - default: true

## Enable collection of query metrics. Requires enabled query samples.

#

# enabled: true

## Configure collection of execution plans

#

# execution_plans:

## @param enabled - boolean - optional - default: true

## Enable collection of execution plans. Requires query metrics.

#

# enabled: true

## Configure collection of shared memory usage

#

# shared_memory:

## @param enabled - boolean - optional - default: true. Requires `dbm: true`.

## Enable collection of database shared memory usages

#

# enabled: true

## Configure collection of database sysmetrics

#

# sysmetrics:

## @param enabled - boolean - optional - default: true

## Enable collection of database sysmetrics

#

# enabled: true

## Configure collection of tablespace usage

#

# tablespaces:

## @param enabled - boolean - optional - default: true

## Enable collection of tablespace usage

#

# enabled: true

## @param collection_interval - int - optional - default: 600

## The interval in seconds between tablespace usage collections.

#

# collection_interval: 600

## Configure collection of process memory usage

#

# processes:

## @param enabled - boolean - optional - default: true

## Enable collection of process memory usage

#

# enabled: true

## Configure collection of resource manager statistics

#

# resource_manager:

## @param enabled - boolean - optional - default: true

## Enable collection of resource manager statistics

#

# enabled: true

## Configure how the SQL obfuscator behaves.

## Note: This option only applies when `dbm` is enabled.

#

# obfuscator_options:

## @param replace_digits - boolean - optional - default: false

## Set to `true` to replace digits in identifiers and table names with question marks in your SQL statements.

## Note: This option also applies to extracted tables using `collect_tables`.

#

# replace_digits: false

## @param collect_metadata - boolean - optional - default: true

## Set to `false` to disable the collection of metadata in your SQL statements.

## Metadata includes things such as tables, commands, and comments.

#

# collect_metadata: true

## @param collect_tables - boolean - optional - default: true

## Set to `false` to disable the collection of tables in your SQL statements.

## Requires `collect_metadata: true`.

#

# collect_tables: true

## @param collect_commands - boolean - optional - default: true

## Set to `false` to disable the collection of commands in your SQL statements.

## Requires `collect_metadata: true`.

##

## Examples: SELECT, UPDATE, DELETE, etc.

#

# collect_commands: true

## @param collect_comments - boolean - optional - default: true

## Set to `false` to disable the collection of comments in your SQL statements.

## Requires `collect_metadata: true`.

#

# collect_comments: true

## @param keep_sql_alias - boolean - optional - default: false

## Set to `true` to keep SQL aliases (AS clauses) in obfuscated queries instead of removing them.

#

# keep_sql_alias: false

## @param obfuscation_mode - string - optional

## Specifies the obfuscation mode for SQL queries. When set, the obfuscator uses an advanced

## SQL lexer for more precise obfuscation and normalization.

##

## Valid values:

## - `normalize_only`: Normalizes queries without obfuscating values

## - `obfuscate_only`: Obfuscates sensitive values without normalization

## - `obfuscate_and_normalize`: Performs both obfuscation and normalization

#

# obfuscation_mode: <OBFUSCATION_MODE>

## @param remove_space_between_parentheses - boolean - optional - default: false

## Set to `true` to remove spaces between parentheses during query normalization.

## By default, spaces are added for readability. Only applies when `obfuscation_mode`

## is set to `normalize_only` or `obfuscate_and_normalize`.

#

# remove_space_between_parentheses: false

## @param keep_null - boolean - optional - default: false

## Set to `true` to preserve NULL values in queries instead of replacing them with `?`.

## Only applies when `obfuscation_mode` is set to `obfuscate_only` or `obfuscate_and_normalize`.

#

# keep_null: false

## @param keep_boolean - boolean - optional - default: false

## Set to `true` to preserve boolean values (TRUE/FALSE) in queries instead of replacing them with `?`.

## Only applies when `obfuscation_mode` is set to `obfuscate_only` or `obfuscate_and_normalize`.

#

# keep_boolean: false

## @param keep_trailing_semicolon - boolean - optional - default: false

## Set to `true` to keep trailing semicolons in queries. By default, trailing semicolons are removed

## during normalization. Only applies when `obfuscation_mode` is set to `normalize_only` or `obfuscate_and_normalize`.

#

# keep_trailing_semicolon: false

## @param keep_identifier_quotation - boolean - optional - default: false

## Set to `true` to preserve identifier quotation marks (e.g., "my_table" or [my_table]) in queries.

## By default, identifier quotation is removed during normalization. Only applies when `obfuscation_mode`

## is set to `normalize_only` or `obfuscate_and_normalize`.

#

# keep_identifier_quotation: false

## @param replace_bind_parameter - boolean - optional - default: false

## Set to `true` to replace SQL bind parameters (e.g., @P1, :param1) with `?` for better query grouping.

#

# replace_bind_parameter: false

## @param use_global_custom_queries - string - optional - default: 'true'

## How `global_custom_queries` should be used for this instance. There are 3 options:

##

## 1. true - `global_custom_queries` override `custom_queries`.

## 2. false - `custom_queries` override `global_custom_queries`.

## 3. extend - `global_custom_queries` are used in addition to any `custom_queries`.

#

# use_global_custom_queries: 'true'

## @param custom_queries - list of mappings - optional

## Each query must have 2 fields, and can have a third optional field:

##

## 1. metric_prefix - Each metric starts with the chosen prefix. The default is `oracle`.

## 2. query - The SQL to execute. It can be a simple statement or a multi-line script.

## Use the pipe `|` if you require a multi-line script.

## 3. columns - The list representing each column, ordered sequentially from left to right.

## The number of columns must equal the number of columns returned in the query.

## There are 2 required pieces of data:

## a. name - The suffix to append to `metric_prefix` to form

## the full metric name. If `type` is `tag`, this column is

## considered a tag and applied to every

## metric collected by this particular query.

## b. type - The submission method (gauge, monotonic_count, etc.).

## This can also be set to `tag` to tag each metric in the row

## with the name and value of the item in this column. You can

## use the `count` type to perform aggregation for queries that

## return multiple rows with the same or no tags.

## Columns without a name are ignored. To skip a column, enter:

## - {}

## 4. tags (optional) - A list of tags to apply to each metric.

## 5. pdb (optional) - A PDB against which the query will be run. Default is CDB$ROOT.

## The parameter can be defined on a self-managed instance, which

## connects to CDB.

#

## WARNING: Running custom queries may result in additional costs or fees assessed by Oracle.

#

# custom_queries:

# - metric_prefix: oracle

# query: SELECT 'foo', 11 FROM dual

# columns:

# - name: foo

# type: tag

# - name: event.total

# type: gauge

# tags:

# - test:tag_value_1

# pdb: <MYPDB>

## Start an SQL trace for Agent queries. This feature is only meant for Agent troubleshooting, and

## should normally be switched off.

## Requires execute the execute privilege on `dbms_monitor` to datadog user

#

# agent_sql_trace:

## @param enabled - boolean - optional - default: false

## Enable SQL trace

#

# enabled: false

## @param binds - boolean - optional - default: false

## include bind variables in trace

#

# binds: false

## @param waits - boolean - optional - default: false

## include wait events in trace

#

# waits: false

## @param enabled - int - optional - default: 10

## Limit the number of traced check executions to avoid filling the file system.

#

# traced_runs: 10