概要

このチェックでは、Datadog Agent を通じて MarkLogic を監視します。MarkLogic Server は、運用データおよび分析データのためのデータハブとして設計されたマルチモデルデータベースです。

セットアップ

ホストで実行されている Agent 用にこのチェックをインストールおよび構成する場合は、以下の手順に従ってください。コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照してこの手順を行ってください。

インストール

MarkLogic チェックは Datadog Agent パッケージに含まれています。 サーバーに追加でインストールする必要はありません。

MarkLogic の準備

API または Admin インターフェイスで、Datadog Agent に manage-user ロール権限が最小限のユーザーを作成します。 enable_health_service_checks コンフィギュレーションを使用する予定の場合は、Datadog MarkLogic ユーザーにu少なくとも manage-admin ロールを付与します。

API

1. 特定の値でこのリクエストを調整し、Datadog ユーザーを作成します。

   curl -X POST --anyauth --user <ADMIN_USER>:<ADMIN_PASSWORD> -i -H "Content-Type: application/json" -d '{"user-name": "<USER>", "password": "<PASSWORD>", "roles": {"role": "manage-user"}}' http://<HOSTNAME>:8002/manage/v2/users
   

   適切な <ADMIN_USER> と <ADMIN_PASSWORD> を使用し、Datadog Agent で使用するユーザー名とパスワードを <USER> および <PASSWORD> に置き換えます。 詳細は、MarkLogic のドキュメント POST /manage/v2/users を参照してください。

2. 作成したユーザーが必要なアクセス許可を持っているかを確認するには

   curl -X GET --anyauth --user <USER>:<PASSWORD> -i http://<HOSTNAME>:8002/manage/v2
   

Admin インターフェイス

1. 監理者アカウントで QConsole にログインします。デフォルトで、QConsole は http://<HOSTNAME>:8000/qconsole で使用可能です。

2. データベースに Security、クエリタイプに XQuery を選択します。

3. このクエリを実行し、Datadog Agent で使用するユーザーとパスワードを <USER> と <PASSWORD> に置き換えます。

   xquery version "1.0-ml";
   import module namespace sec="http://marklogic.com/xdmp/security" at 
       "/MarkLogic/security.xqy";
   
   sec:create-user(
       "<USER>",
       "Datadog Agent user",
       "<PASSWORD>",
       "manage-user",
       (xdmp:permission("security", "read")),
       ("http://marklogic.com/dev_modules"))
   

   詳細は、MarkLogic のドキュメント sec:create-user を参照してください。

4. 作成されたユーザーに十分な権限があることを確認するには、<USER> および <PASSWORD> を使用して http://<HOSTNAME>:8002 (デフォルトポート) で認証します。

構成

ホスト

1. MarkLogic のパフォーマンスデータの収集を開始するには、Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーの marklogic.d/conf.yaml ファイルを編集します。使用可能なすべてのコンフィギュレーションオプションについては、サンプル marklogic.d/conf.yaml ファイルを参照してください。コンフィグファイルのユーザー関連の設定については、作成した Datadog Agent ユーザーを使用します。

2. Agent を再起動します。

ログ収集

Agent バージョン 6.0 以降で利用可能

1. Datadog Agent で、ログの収集はデフォルトで無効になっています。以下のように、datadog.yaml でこれを有効にする必要があります。

   logs_enabled: true
   

2. MarkLogic のログの収集を開始するには、次の構成ブロックを marklogic.d/conf.yaml ファイルに追加します。

     logs:
       - type: file
         path: /var/opt/MarkLogic/Logs/ErrorLog.txt
         source: marklogic
       - type: file
         path: /var/opt/MarkLogic/Logs/80002_AccessLog.txt
         source: marklogic
   

   path の値を変更し、環境に合わせて構成します。使用可能なすべてのコンフィギュレーションオプションの詳細については、サンプル marklogic.d/conf.yaml ファイルを参照してください。

3. Agent を再起動します。

検証

Agent のステータスサブコマンドを実行し、Checks セクションで marklogic を探します。

収集データ

メトリクス

イベント

MarkLogic には、イベントは含まれません。

サービスチェック

marklogic.can_connect
Returns CRITICAL if the Agent is unable to reach the query endpoint. Returns OK otherwise.
Statuses: ok, critical, unknown

marklogic.database.health
Returns CRITICAL if the database state is critical; WARNING if it is maintenance, offline, or at-risk; and OK otherwise.
Statuses: ok, warning, critical, unknown

marklogic.forest.health
Returns CRITICAL if the forest state is critical; WARNING if it is maintenance, offline, or at-risk; and OK otherwise.
Statuses: ok, warning, critical, unknown

トラブルシューティング

ご不明な点は、Datadog のサポートチームまでお問合せください。