Datadog Apps

ベータ版に参加しよう

Datadog アプリは現在ベータ版ですが、簡単にアクセスをリクエストすることができます。このフォームを使用して、今すぐリクエストを送信してください。承認されると、ご自身や組織のため、または素晴らしい Datadog アプリが流通する Datadog コミュニティ全体に公開するために、創造的なアプリの開発を始めることができます。

アプリとは?

Datadog アプリは、開発者がカスタムダッシュボードウィジェットを通じて Datadog のネイティブ機能を拡張できるようにするものです。例えば、Datadog がサポートしていないデータの可視化や、サードパーティのプラットフォームで実行する一般的な修復ワークフローがある場合、Datadog 内でこの機能を拡張するアプリを作成することができます。

セットアップ

ローカル開発環境の設定

  1. Datadog アプリを作成します。

    yarn create @datadog/app
    
  2. 作成したフォルダに移動します。

    cd starter-kit
    
  3. 開発環境を設定します。

    yarn start
    

これにより、http://localhost:3000/ 上のローカル開発サーバーが起動します。

以下のメッセージが表示されれば、アプリケーションは実行されています。

The application controller is running in the background

2 つのページがあることに注意してください。

  • http://localhost:3000: ウィジェット、メニュー、モーダルなどの様々な拡張機能を管理するメインコントローラーです。アプリの機能を充実させる際に、便利に使えるでしょう。
  • http://localhost:3000/widget: ウィジェットやモーダルなど、専用の表示が必要なもの用のコンポーネントです。

このアーキテクチャの詳細については、Developer Platform 開発者ガイドを参照してください。

ブラウザでローカルウィジェットを直接操作すると、JavaScript コンソールでキャッチされない HandshakeTimeoutError が表示されることがあります。これは予想されることです。Datadog Apps SDK は、Datadog ユーザーインターフェイスに接続する iframe で実行するように設計されており、SDK が通信する Datadog UI がない場合、ウィジェットと Datadog UI 間のハンドシェイク試行はタイムアウトします。

アプリを Developer Platform に追加する

  1. Integrations > Developer Platform に移動して、+ New App をクリックします。 Add a new app to the developer platform

  2. アプリケーションの一意の名前を入力します。

  3. オプションで、新しいアプリケーションのダッシュボードが表示されたら、アプリ名を変更したり、アプリに詳細な説明を加えたり、アイコンを変更したりすることができます。 Edit app information from the app dashboard

ダッシュボードにアプリを追加する

  1. アプリをダッシュボードに追加する前に、UI Extensions をクリックして、アプリを有効にする必要があります。 App Edit Enable UI Extensions

    このビューがロードされたら、Enable UI Extensions ボタンをクリックします。

  2. アプリのオプションがさらに表示されたら、実行中のウィジェットの localhost のバージョンに合わせて、Root URLDebug Mode Root URL を変更します。メインコントローラーのパスは /widget です。これらの URL の値は、アプリケーションを構築し、独自のインフラストラクチャーでホストし始めると、変更されます。

  3. トグルを Dashboard Custom Widget にします。これでアプリ用の JSON が生成されます。

    App Edit UI Extensions

    この例では、JSON 出力に Your first widget という値が含まれています。これは、ダッシュボードに追加するメニューに表示される、ウィジェットの名前です。

  4. ダッシュボードに移動して、ウィジェットを追加します。

    Add widget to your Dashboard
  5. サイドバーの一番下に Custom Widgets というセクションがあります。リストでウィジェットを探し、ダッシュボードに追加します。

    Add your widget from the custom widgets section
  6. 新しいウィジェットのプレビューが、いくつかのオプションとともに表示されます。下にスクロールし、Done をクリックして、ダッシュボードに追加します。

    Click Done to add your widget to the dashboard
  7. アプリケーションをビルドするには、ターミナルで yarn build を実行します。次に、静的に生成されたサイトを任意のホスティングプラットフォームに移動し、アプリの設定で URL を更新します。

OAuth API アクセス

OAuth API Access を有効にすると、アプリを使用する前にユーザーの認証が必要になります。この機能により、既存の認証メカニズム (例えば、Cookie ベースのユーザー名とパスワードによるログイン) を Developer Platform と統合することができます。

サンプルアプリケーション

その他の参考資料