Linux

1. Linux 用の Oracle Instant Client のインストールに従ってください。

2. 以下を確認してください。

   • Instant Client Basic パッケージと SDK パッケージの両方がインストールされます。Oracle のダウンロードページにあります。

     Instant Client ライブラリのインストール後に、ランタイムリンカがライブラリを見つけることができることを確認します。たとえば、ldconfig を使用します。

     # Put the library location in an ld configuration file.
     
     sudo sh -c "echo /usr/lib/oracle/12.2/client64/lib > \
         /etc/ld.so.conf.d/oracle-instantclient.conf"
     
     # Update the bindings.
     
     sudo ldconfig
     

   • 両方のパッケージは、特定のマシン上のすべてのユーザーが使用できる単一のディレクトリ (たとえば、/opt/oracle) に解凍されます。

     mkdir -p /opt/oracle/ && cd /opt/oracle/
     unzip /opt/oracle/instantclient-basic-linux.x64-12.1.0.2.0.zip
     unzip /opt/oracle/instantclient-sdk-linux.x64-12.1.0.2.0.zip
     

Windows

1. Oracle Windows インストールガイドに従って、Oracle Instant Client を構成します。

2. 以下を確認してください。

   • Microsoft Visual Studio 2017 再頒布可能パッケージまたは適切なバージョンが Oracle Instant Client にインストールされます。

   • Oracle のダウンロードページの Instant Client Basic パッケージと SDK パッケージの両方がインストールされます。

   • 両方のパッケージは、特定のマシン上のすべてのユーザーが使用できる単一のディレクトリ (たとえば、C:\oracle) に抽出されます。

Oracle Database サーバーへの適切なアクセス権を持つ、読み取り専用の datadog ユーザーを作成します。SYSDBA や SYSOPER などの管理者ユーザーで Oracle Database に接続し、以下を実行します。

-- Oracle Script を有効にします。
ALTER SESSION SET "_ORACLE_SCRIPT"=true;

-- Datadog ユーザーを作成します。パスワードのプレースホルダーは、安全なパスワードに置き換えてください。
CREATE USER datadog IDENTIFIED BY <パスワード>;

-- Datadog ユーザーにアクセス権を付与します。
GRANT CONNECT TO datadog;
GRANT SELECT ON GV_$PROCESS TO datadog;
GRANT SELECT ON gv_$sysmetric TO datadog;
GRANT SELECT ON sys.dba_data_files TO datadog;
GRANT SELECT ON sys.dba_tablespaces TO datadog;
GRANT SELECT ON sys.dba_tablespace_usage_metrics TO datadog;

注: Oracle 11g を使用している場合、次の行を実行する必要はありません。

ALTER SESSION SET "_ORACLE_SCRIPT"=true;

Oracle 12c または 19c

管理者としてルートデータベースにログインして、datadog ユーザーを作成し、アクセス許可を付与します。

alter session set container = cdb$root;
CREATE USER c##datadog IDENTIFIED BY password CONTAINER=ALL;
GRANT CREATE SESSION TO c##datadog CONTAINER=ALL;
Grant select any dictionary to c##datadog container=all;
GRANT SELECT ON GV_$PROCESS TO c##datadog CONTAINER=ALL;
GRANT SELECT ON gv_$sysmetric TO c##datadog CONTAINER=ALL;

ホスト

ホストで実行中の Agent に対してこのチェックを構成するには:

1. Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーの oracle.d/conf.yaml ファイルを編集します。server と port を更新し、監視するマスターを設定します。使用可能なすべてのコンフィギュレーションオプションの詳細については、サンプル oracle.d/conf.yaml を参照してください。

   init_config:
   
   instances:
      ## @param server - string - required
      ## The IP address or hostname of the Oracle Database Server.
      #
      - server: localhost:1521
   
        ## @param service_name - string - required
        ## The Oracle Database 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 username - string - required
        ## The username for the Datadog user account.
        #
        username: <USERNAME>
   
        ## @param password - string - required
        ## The password for the Datadog user account.
        #
        password: <PASSWORD>
   

2. Agent を再起動します。

カスタムクエリのみ

インスタンスのデフォルトのメトリクスチェックをスキップし、既存のメトリクス収集ユーザーでのみカスタムクエリを実行するには、値が true のタグ only_custom_queries を挿入します。これにより、Oracle インテグレーションの構成済みインスタンスがシステム、プロセス、およびテーブルスペースメトリクスの実行をスキップし、Datadog ユーザー作成セクションで説明されているアクセス許可なしでカスタムクエリを実行できます。この構成エントリが省略された場合、指定したユーザーには、カスタムクエリを実行するためのテーブルアクセス許可が必要です。

init_config:

instances:
  ## @param server - string - required
  ## The IP address or hostname of the Oracle Database Server.
  #
  - server: localhost:1521

    ## @param service_name - string - required
    ## The Oracle Database 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 user - string - required
    ## The username for the user account.
    #
    user: <USER>

    ## @param password - string - required
    ## The password for the user account.
    #
    password: "<PASSWORD>"

    ## @param only_custom_queries - string - optional
    ## Set this parameter to any value if you want to only run custom
    ## queries for this instance.
    #
    only_custom_queries: true

TCPS による Oracle への接続

1. TCPS (TCP with SSL) を使って Oracle に接続するには、protocol 構成オプションのコメントを解除して、TCPS を選択します。server オプションを更新して、監視する TCPS サーバーを設定します。

   init_config:
   
   instances:
     ## @param server - string - required
     ## The IP address or hostname of the Oracle Database Server.
     #
     - server: localhost:1522
   
       ## @param service_name - string - required
       ## The Oracle Database 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 user - string - required
       ## The username for the user account.
       #
       user: <USER>
   
       ## @param password - string - required
       ## The password for the user account.
       #
       password: "<PASSWORD>"
   
       ## @param protocol - string - optional - default: TCP
       ## The protocol to connect to the Oracle Database Server. Valid protocols include TCP and TCPS.
       ##
       ## When connecting to Oracle Database via JDBC, `jdbc_truststore` and `jdbc_truststore_type` are required.
       ## More information can be found from Oracle Database's whitepaper:
       ##
       ## https://www.oracle.com/technetwork/topics/wp-oracle-jdbc-thin-ssl-130128.pdf
       #
       protocol: TCPS
   

2. Oracle Database で TCPS 接続を許可するために、sqlnet.ora、listener.ora、tnsnames.ora を更新します。

JDBC を使用しない Oracle 経由の TCPS

JDBC を使用していない場合、Datadog Agent がデータベースに接続できることを確認します。構成オプションに入力された情報を使って、sqlplus コマンドラインツールを使用します。

sqlplus <USER>/<PASSWORD>@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCPS)(HOST=<HOST>)(PORT=<PORT>))(SERVICE_NAME=<SERVICE_NAME>)))

Oracle Instant Client による接続を使用する際は、アプリケーションによって使用されるクライアントライブラリの network/admin ディレクトリに 3 つのファイルを移動します。

• tnsnames.ora: アプリケーションの接続文字列で使用されるネットサービス名をデータベースサービスにマッピングします。
• sqlnet.ora: Oracle Network の設定を構成します。
• cwallet.sso: SSL または TLS 接続を有効にします。このファイルの安全性を確保するようにしてください。

JDBC による TCPS

JDBC を使用して Oracle Database に接続している場合は、jdbc_truststore_path、jdbc_truststore_type、および Truststore にパスワードがある場合は jdbc_truststore_password (オプション) も指定する必要があります。

注: SSO のトラストストアはパスワードを必要としません。

    # `instances:` セクションで
    ...

    ## @param jdbc_truststore_path - 文字列 - オプション
    ## JDBC トラストストアのファイルパス。
    #
    jdbc_truststore_path: /path/to/truststore

    ## @param jdbc_truststore_type - 文字列 - オプション
    ## JDBC トラストストアのファイルタイプ。サポートされているトラストストアのタイプには、JKS、SSO、および PKCS12 があります。
    #
    jdbc_truststore_type: SSO

    ## @param jdbc_truststore_password - 文字列 - オプション
    ## JDBC で接続する際のトラストストアのパスワード。
    #
    # jdbc_truststore_password: <JDBC_TRUSTSTORE_PASSWORD>

TCPS on JDBC による Oracle Database への接続の詳細については、公式の Oracle ホワイトペーパーを参照してください。

コンテナ化

コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照して、次のパラメーターを適用してください。