My Home NW Lab

逸般の誤家庭のネットワーク

DatadogでMeraki Dashboard APIを用いてMerakiのログを取得する

DatadogでMeraki Dashboard APIを用いてMerakiのログを取得する設定方法を紹介します。 DatadogのTrial期間の機能で試せるので、Merakiの検証環境があるのであれば使用感の確認に活用できます。

DatadogのMerakiの連携のサンプル画面

DatadogのサービスからMeraki Cloudに対してMeraki Dashboard APIを用いて通信が行われるため、利用者側ではログ取得に際してのエージェント導入は不要になるのが利点です。

DatadogによるMerakiのログの取り込み

設定手順

Meraki Dashboard APIの有効化

MarketplaceからMeraki Integrationの設定

  • メニュー: Integrations > Marketplace を開きます。

    メニュー: Integrations > Marketplace

  • 検索ワードに Meraki と入力して Meraki のAppを見つけて開きます。

    MerakiのApp

  • Meraki Integration のポップアップ画面で Configuration タブに移動して、Create the Integration のセクションより Add new ボタンを押下します。

    Meraki Integration の設定画面

  • Account NameAPI KEY を設定します。

    Account Name と API KEY の設定

    1. Account Name には任意の名称を入力します。Merakiアカウントのメール アドレスを指定する箇所ではありません。 また、画面上のメッセージにも記載がありますが、入力規則があり、英数字とアンダースコア (_)のみを受け付けます。

      Create the Integration
      1. Choose an account name for the integration account. The account name can only contain alphanumeric values and underscores.
      2. Add the previously generated Meraki API key.

    2. API KEY には、予め生成しておいたMeraki Dashboard APIAPI Keyを指定します。

    3. 入力が完了したら Save ボタンの押下を忘れないようにしてください。設定が保存されると下記のような画面になります。

      Account Name と API KEY の保存後

Merakiのログの確認

  • メニュー: Logs > Configuration を開きます。

  • Pipelines タブが表示されるので、PIPELINE NAME: Cisco Meraki のセクションを探して、View in Log Explorer ボタンを押下します。

    PIPELINE NAME: Cisco Meraki のセクションと View in Log Explorer ボタン

    View in Log Explorer ボタンは BY のカラム付近をマウス オーバーすると表示されるので注意してください。

    View in Log Explorer (BY のカラム付近)

  • Search for の検索ボックスに Source:meraki と表示された状態で Logs (メニュー: Logs > Search) の画面が開きます。

    Logs (メニュー: Logs > Search) 画面の表示

  • Meraki側のログの出力状況によっては、直近の期間では何も出力されていない可能性もあるため、必要に応じて表示期間を切り替えます。

    ログの表示期間の切り替え

  • 下記のサンプル画面は 1w (Past 7 Days / 1 Week) に表示を切り替えて、Merakiのログが確認できた例です。

    Merakiログの確認 (表示期間の切り替え後)

Meraki Integration の関連ドキュメント

備考

Meraki Dashboard APIAPI Keyに複数のOrganizationが紐付いている場合は、それら複数のOrganizationに対してログの取得処理が走るように見受けられました。
なお、ドキュメントに詳細な挙動が載っていなかったので実機ベースで確認した情報となります。

複数のOrganizationに対してAPIリクエストの処理が走っているのは、 GET /organizations/{organizationId}/apiRequestsAPIでログを出力して確認しました。
User Agentの情報に "userAgent": "MerakiIntegration/1.0 Datadog" とDatadogの文字列があり、ログ取得のAPIを叩いていたので識別は容易でした。

developer.cisco.com

GET /organizations/{organizationId}/apiRequests によるDatadogからのAPIリクエストの確認