SQL Server 用 DBM セットアップのトラブルシューティング

このページでは、SQL Server によるデータベースモニタリングのセットアップおよび使用に関する一般的な問題と、その解決方法について詳しく説明します。Datadog では、Agent のバージョンリリースにより内容が変更となる可能性があるため、最新の安定した Agent バージョンを使用し、最新のセットアップドキュメントに従っていただくことをお勧めします。

Diagnosing common connection issues

SQL Server unable to connect ‘Login Failed for user’

Agent が SQL Server インスタンスに接続するには、2 つの方法があります。

  1. Windows 認証 (Windows ホストでのみ利用可)

  2. SQL Server 認証

Windows 認証は、デフォルトの認証モードで、SQL Server 認証よりも安全です。Windows 認証を使用することで、ドメインレベルで Windows グループを作成し、そのグループ全体に対して SQL Server 上でログインを作成することができます。Windows 認証を使用するためには、以下のことが必要です。

  1. Agent インストール時に作成したサービスアカウントを使用し、このアカウントが SQL Server への適切なアクセス権を持っていることを確認します。

  2. connection_string: "Trusted_Connection=yes" を設定し、usernamepassword フィールドを省略します。Trusted_Connection=yes の接続属性は、SQL Server 用 OLE DB ドライバーが Windows 認証を使用してログインを確認するように指示します。

SQL Server の認証は Windows のユーザーアカウントではなく、インスタンスで作成され、SQL Server 自体に保存されます。SQL 認証では、SQL Server インスタンス構成で usernamepassword を設定して接続する必要があります。

ログインエラーで接続できない場合、まず Datadog Agent のユーザーとしてインスタンスにログインできることを確認することが重要です。これを行う簡単な方法は、sqlcmd のようなコマンドラインユーティリティを使用することです。

例:

# この例では、SQL 認証を使用しています
sqlcmd -S <INSTANCE_ENDPOINT> -U datadog -P <DATADOG_PASSWORD> -d master

# この例では、Windows 認証を使用しています
# パワーシェルで `run as user…` オプションを選択し、ddagentuser としてこのコマンドを実行します
sqlcmd -S <INSTANCE_ENDPOINT> -d master -E

datadog ユーザーが SQL Server インスタンスにログインできない場合、セットアップドキュメントに従ってユーザーが作成され、適切な権限が付与されていることを確認してください。

マイクロソフトは、この種のエラーのトラブルシューティングに関する有用なドキュメントを提供しており、こちらを参照することができます。

SQL Server TCP 接続エラー

TCP 接続の問題は、Agent の設定に誤構成がある場合によく発生します。ドライバーが提供するエラーメッセージは、必ずしも明確ではありません。

例えば、次のようなエラーは、TCP 接続に失敗したためです。

TCP-connection(ERROR: getaddrinfo failed). Exception: unable to connect: could not open database requested by login

よくあるエラーは、以下の通りです。

“login failed for user”: これは、Agent がホストへの接続を確立することに成功したが、何らかの理由でログインが拒否されたことを意味します。

トラブルシューティングを行うには

  1. Agent のログイン資格情報を確認する

  2. sqlcmd を使って、これらの資格情報で手動でログインしてみてください。例: sqlcmd -S localhost -U datadog -P ${SQL_PASSWORD} -d master

“could not open database requested for login”: このエラーは、ネットワークの問題または不明なデータベースが原因で表示されます。

トラブルシューティングを行うには

  1. telnet {host} {port} を実行して、Agent からホストへの TCP 接続を確認して、Agent からデータベースへのネットワーク接続があることを確認します。

  2. sqlcmd を使用して手動でログインし、構成されたデータベースに問題がないか確認してみてください。例: sqlcmd -S localhost -U datadog -P ${SQL_PASSWORD} -d master

“Invalid connection string attribute” のため

Windows では、以下の ADO プロバイダーがサポートされています: SQLOLEDBMSOLEDBSQLMSOLEDBSQL19SQLNCLI11

SQLOLEDBSQLNCLI11 プロバイダーは、いくつかの重大な問題のために Invalid connection string attribute というエラーメッセージを表示することがありました。例:

datadog_checks.sqlserver.connection.SQLConnectionError:
Unable to connect to SQL Server for instance foo.com,1433 - master:
OperationalError(com_error(-2147352567, 'Exception occurred.',
(0, 'Microsoft OLE DB Provider for SQL Server',
'Invalid connection string attribute', None, 0, -2147467259), None),
'Error opening connection to "ConnectRetryCount=2;Provider=SQLOLEDB;Data Source=foo.com,1433;Initial Catalog=master;User ID=datadog;Password=******;"')

このエラーは、失敗の理由 (例えば、不明なホスト名、TCP 接続が確立されていない、無効なログイン資格情報、不明なデータベースなど) に関係なく、同じエラーが表示されます。

エラーメッセージの中にある HResult のエラーコードを確認してください。これらは既知のコードの例です。

-2147217843 “login failed for user”: これは、Agent がホストへの接続を確立することに成功したが、何らかの理由でログインが拒否されたことを意味します。

-2147467259 “could not open database requested for login”: このエラーは、ネットワークの問題または不明なデータベースが原因で表示されます。

どちらの手順でも問題が解決しない場合、または表示されるエラーコードがリストにない場合、Datadog は MSOLEDBSQL ドライバーまたは Microsoft ODBC Driver for SQL Server を使用することを推奨しています。これらのドライバーは、より詳細なエラーメッセージを提供し、接続が失敗している理由のトラブルシューティングに役立ちます。

SQL Server ‘Unable to connect: Adaptive Server is unavailable or does not exist’

このエラーは、host フィールドが適切に設定されていないために発生することがあります。インテグレーションでは、host フィールドを構文 host:server,port で設定します。

例えば、host をこのように設定した場合:

host: sqlserver-foo.cfxxae8cilce.us-east-1.rds.amazonaws.com

ポートを追加する必要があり、代わりに以下のように設定します。

host: sqlserver-foo.cfxxae8cilce.us-east-1.rds.amazonaws.com,1433

SSL Provider: The certificate chain was issued by an authority that is not trusted

Microsoft OLE DB Driver 2019

This error is common after upgrading to the MSOLEDBSQL 2019 driver due to breaking changes that were introduced. In the latest version of the driver, all connections to the SQL instance are encrypted by default.

If you are using the latest version of the Microsoft OLE DB Driver for SQL Server, and trying to connect to a SQL Server instance which requires encrypted connections, you can use one of the following workarounds:

  1. 自己署名証明書とサーバーの Force Encryption 設定 (AWS では rds.force_ssl=1) により、クライアントが暗号化されて接続されるようにする場合:

    • Change to a certificate that is trusted as part of the client’s trust chain.
    • Add the self-signed certificate as a trusted certificate on the client.
    • Add Trust Server Certificate=True; to the connection string.

これについては、マイクロソフトのドキュメントで詳しく説明されています。

  1. SQL Server インスタンスが暗号化を必要としない接続の場合 (AWS では rds.force_ssl=0)、接続文字列に Use Encryption for Data=False; を追加して更新してください。例:
# example uses windows authentication
instances:
  - host: <INSTANCE_ENDPOINT>,<PORT>
    connection_string: "Trust Server Certificate=True;Use Encryption for Data=False;"
    connector: adodbapi
    adoprovider: MSOLEDBSQL19
  1. デフォルトで暗号化を使用しない 2018 年版の MSOLEDBSQL ドライバーをインストールします。ドライバーをインストール後、adoproviderMSOLEDBSQL に更新します。例:
# example uses windows authentication
instances:
  - host: <INSTANCE_ENDPOINT>,<PORT>
    connection_string: "Trusted_Connection=yes;"
    connector: adodbapi
    adoprovider: MSOLEDBSQL

Other Microsoft OLE DB and ODBC driver versions

If you are using an OLE DB driver other than MSOLEDBSQL 2019 or ODBC drivers, this error can be resolved by setting TrustServerCertificate=yes in the connection string. For example, for the ODBC driver:

# this example uses SQL Server authentication
instances:
  - host: <INSTANCE_ENDPOINT>,<PORT>
    username: datadog
    password: <DD_AGENT_PASSWORD>
    connection_string: "TrustServerCertificate=yes;"
    connector: odbc
    driver: '{ODBC Driver 18 for SQL Server}'

SQL Server unable to connect ‘SSL Security error (18)’

これは、古いバージョンの SQL Server ODBC ドライバーで発生する既知の問題です。エラーメッセージの接続文字列を見れば、Agent がどのバージョンのドライバーを使用しているか確認できます。

例えば、エラーメッセージの接続文字列に Provider=SQL Server と表示されている場合、ODBC ドライバーを新しいバージョンにアップグレードすると、エラーが修正されます。

この問題は、このマイクロソフトのブログ記事で詳しく説明されています。

Empty connection string

Datadog の SQL Server チェックは、adodbapi Python ライブラリに依存しており、このライブラリは、SQL Server への接続文字列を作成する際に使用できる文字にいくつかの制限があります。もし、Agent が SQL Server への接続に問題があり、Agent の collector.logs に以下のようなエラーがある場合、sqlserver.yamladodbapi で問題が発生する文字が含まれている可能性があります。

OperationalError: (KeyError('Python string format error in connection string->',), 'Error opening connection to ""')

現時点では、この特定の接続問題を引き起こすことが知られている唯一の文字は、% 文字です。もし、sqlserver.yaml ファイルで % 文字を使用する必要がある場合 (例えば、Datadog SQL Server のユーザーパスワードに % が含まれている場合)、各 % の代わりに %% を 2 つ記述して、その文字をエスケープする必要があります。

Diagnosing common SQL Server driver issues

Data source name not found, and no default driver specified

これは、Linux で ODBC ドライバーのデフォルト設定を使用しているときに見られる一般的なエラーです。これは、/etc/odbcinst.ini ファイルでドライバーに設定されている DSN が、Agent 構成で設定されているドライバーの名前と一致しないために発生する可能性があります。

例えば、Agent のデフォルトの ODBC ドライバー ({ODBC Driver 18 for SQL Server}) を使用したい場合、インスタンス構成には以下の内容を含める必要があります。

  connector: odbc

Agent が起動し、SQL Server インスタンスへの接続を確立しようとするとき、Agent は /etc/odbcinst.ini ファイルを探し、ドライバーバイナリへのパスを見つけます。

例えば、この /etc/odbcinst.ini ファイルは、ドライバーを設定します。

```text
$ cat /etc/odbcinst.ini
[ODBC Driver 18 for SQL Server]
Description=Microsoft ODBC Driver 18 for SQL Server
Driver=/opt/microsoft/msodbcsql/lib64/libmsodbcsql-13.1.so.7.0
UsageCount=1
```

上記の例の DSN は [ODBC Driver 18 for SQL Server] で、これは Agent が使用しているデフォルトのドライバー名と一致しています。もし、お使いのドライバーの DSN が Agent が使用しているドライバーの名前と一致しない場合、Data source not found というエラーが発生します。

インスタンス設定の dsn/etc/odbcinst.ini ファイルで設定されているものと一致させることが可能です。例:

```text
$ cat /etc/odbcinst.ini
[Custom]
Description=Microsoft ODBC Driver 18 for SQL Server
Driver=/opt/microsoft/msodbcsql/lib64/libmsodbcsql-13.1.so.7.0
UsageCount=1
```

インスタンス構成で、dsn フィールドを設定します。

  connector: odbc
  dsn: "Custom"

Provider or driver not found

このエラーメッセージはドライバーによって表現が異なりますが、通常、ODBC では以下のようになります。

  1. Can't open lib .* file not found
  2. Data source name not found.* and no default driver specified

また、MSOLEDBSQL プロバイダーの場合は、次のようなエラーメッセージが表示されます。

Provider cannot be found. It may not be properly installed.

これは、Agent が動作しているホストに、ドライバーまたはプロバイダーが正しくインストールされていないことを意味します。使用するドライバーのインストール手順にすべて従っていることを確認する必要があります。

Agent がドライバーを見つけられない可能性があります。これは、Linux 上の ODBC ドライバーでより一般的です。Linux に ODBC ドライバーをインストールする方法については、Linux ホストで SQL Server に接続するのセクションを参照してください。

ドライバーの選択については、SQL Server ドライバーの選択のセクションを参照して、Agent でドライバーを適切に構成する方法を確認してください。

Linux ホストでの SQL Server への接続

SQL Server (Linux または Windows にホストされている) を Linux ホストに接続するには

  1. お使いの Linux ディストリビューション用の Microsoft ODBC Driver をインストールします。 使用するドライバー名がわからない場合は、/etc/odbcinst.ini の先頭にある括弧で囲まれたドライバー名を確認することができます。

    $ cat /etc/odbcinst.ini
    [ODBC Driver 13 for SQL Server]
    Description=Microsoft ODBC Driver 13 for SQL Server
    Driver=/opt/microsoft/msodbcsql/lib64/libmsodbcsql-13.1.so.7.0
    UsageCount=1
    
  2. odbc.ini ファイルと odbcinst.ini ファイルを /opt/datadog-agent/embedded/etc フォルダーにコピーします。

  3. 必要であれば、pyodbc モジュールをインストールします。これは、Agent の Python 環境内で pip install pyodbc を実行することで行うことができます。例えば、以下のようになります。

    $ sudo /opt/datadog-agent/embedded/bin/pip install pyodbc
    
  4. SQL Server の conf.yaml を構成して、odbc コネクターを使用し、odbcinst.ini ファイルに示されているように適切なドライバーを指定します。

    init_config:
    
    instances:
      - host: <HOST>,<PORT>
        # enable the odbc connector
        connector: odbc
        # enable the ODBC driver
        driver: ODBC Driver 13 for SQL Server
        username: <USERNAME>
        password: <PASSWORD>
    

Picking a SQL Server driver

Agent が SQL Server インスタンスに接続するためには、Microsoft ODBC ドライバーまたは OLE DB ドライバーのいずれかをインストールする必要があります。

選択したドライバーによって、インスタンス構成のコネクターフィールドに何を設定するかが決まります。

例えば、Microsoft ODBC ドライバーの場合:

connector: odbc
driver: '{ODBC Driver 18 for SQL Server}'

OLE DB ドライバーの場合:

connector: adodbapi
adoprovider: MSOLEDBSQL

これらの値は、接続文字列の Provider 部分にマッピングするために使用されます。

そのため、例えば adoprovider: MSOLEDBSQL を設定すると、接続文字列には Provider=MSOLEDBSQL が含まれることになります。これは、インストールしたドライバのバージョン名と一致するはずです。

Microsoft OLE DB ドライバーの最新版では、ドライバー名が MSOLEDBSQL から MSOLEDBSQL19 に変更されていますので、インスタンス構成にこのように表示されるはずです。

connector: adodbapi
adoprovider: MSOLEDBSQL19

選択したドライバーは、常に最新のバージョンを使用することをお勧めします。

その他のよくある問題

Query Metrics と Plan Samples に SQL Server のユーザータグが表示されない

SQL Server の技術的な制限により、正しいユーザーが実行しているクエリを収集できないため、user タグは Query Metrics と Plan Samples のためにサポートされなくなりました。

user タグは、Query Activity イベントと Database Load メトリクスで利用可能です。

なぜ “CREATE PROCEDURE” クエリが多いのですか?

7.40.0 より古いバージョンの Agent では、PROCEDURE 統計が過大にカウントされるバグがあります。これにより、データベースをモニタリングする Query Metrics UI で CREATE PROCEDURE... の実行が多数表示されるようになります。この問題を解決するには、Datadog Agent を最新バージョンにアップグレードしてください。

既知の制限

SQL Server 2012

The following metrics are not available for SQL Server 2012:

  • sqlserver.files.read_io_stall_queued
  • sqlserver.files.write_io_stall_queued
  • sqlserver.ao.quorum_type
  • sqlserver.ao.quorum_state
  • sqlserver.ao.member.type
  • sqlserver.ao.member.state
  • sqlserver.ao.member.number_of_quorum_votes
  • sqlserver.ao.log_send_queue_size
  • sqlserver.ao.log_send_rate
  • sqlserver.ao.redo_queue_size
  • sqlserver.ao.redo_rate
  • sqlserver.ao.low_water_mark_for_ghosts
  • sqlserver.ao.filestream_send_rate
  • sqlserver.ao.replica_status
  • sqlserver.ao.secondary_lag_seconds
  • sqlserver.fci.status
  • sqlserver.fci.is_current_owner
  • sqlserver.latches.latch_wait_time

SQL Server 2014

The following metrics are not available for SQL Server 2014:

  • sqlserver.ao.secondary_lag_seconds
  • sqlserver.latches.latch_wait_time