ベータ版に参加しよう
Datadog アプリは現在ベータ版ですが、簡単にアクセスをリクエストすることができます。このフォームを使用して、今すぐリクエストを送信してください。承認されると、ご自身や組織のため、または素晴らしい Datadog アプリが流通する Datadog コミュニティ全体に公開するために、創造的なアプリの開発を始めることができます。
アプリとは？
Datadog アプリは、開発者がカスタムダッシュボードウィジェットを通じて Datadog のネイティブ機能を拡張できるようにするものです。例えば、Datadog がサポートしていないデータの可視化や、サードパーティのプラットフォームで実行する一般的な修復ワークフローがある場合、Datadog 内でこの機能を拡張するアプリを作成することができます。
セットアップ
ローカル開発環境の設定
Datadog アプリを作成します。
作成したフォルダに移動します。
開発環境を設定します。
これにより、http://localhost:3000/ 上のローカル開発サーバーが起動します。
以下のメッセージが表示されれば、アプリケーションは実行されています。
2 つのページがあることに注意してください。
http://localhost:3000: ウィジェット、メニュー、モーダルなどの様々な拡張機能を管理するメインコントローラーです。アプリの機能を充実させる際に、便利に使えるでしょう。http://localhost:3000/widget: ウィジェットやモーダルなど、専用の表示が必要なもの用のコンポーネントです。
このアーキテクチャの詳細については、Developer Platform 開発者ガイドを参照してください。
ブラウザでローカルウィジェットを直接操作すると、JavaScript コンソールでキャッチされない
HandshakeTimeoutError が表示されることがあります。これは予想されることです。Datadog Apps SDK は、Datadog ユーザーインターフェイスに接続する iframe で実行するように
設計されており、SDK が通信する Datadog UI がない場合、ウィジェットと Datadog UI 間のハンドシェイク試行はタイムアウトします。
Integrations > Developer Platform に移動して、+ New App をクリックします。
アプリケーションの一意の名前を入力します。
オプションで、新しいアプリケーションのダッシュボードが表示されたら、アプリ名を変更したり、アプリに詳細な説明を加えたり、アイコンを変更したりすることができます。
ダッシュボードにアプリを追加する
アプリをダッシュボードに追加する前に、UI Extensions をクリックして、アプリを有効にする必要があります。
このビューがロードされたら、Enable UI Extensions ボタンをクリックします。
アプリのオプションがさらに表示されたら、実行中のウィジェットの localhost のバージョンに合わせて、Root URL と Debug Mode Root URL を変更します。メインコントローラーのパスは /widget です。これらの URL の値は、アプリケーションを構築し、独自のインフラストラクチャーでホストし始めると、変更されます。
トグルを Dashboard Custom Widget にします。これでアプリ用の JSON が生成されます。
この例では、JSON 出力に Your first widget という値が含まれています。これは、ダッシュボードに追加するメニューに表示される、ウィジェットの名前です。
ダッシュボードに移動して、ウィジェットを追加します。
サイドバーの一番下に Custom Widgets というセクションがあります。リストでウィジェットを探し、ダッシュボードに追加します。
新しいウィジェットのプレビューが、いくつかのオプションとともに表示されます。下にスクロールし、Done をクリックして、ダッシュボードに追加します。
アプリケーションをビルドするには、ターミナルで yarn build を実行します。次に、静的に生成されたサイトを任意のホスティングプラットフォームに移動し、アプリの設定で URL を更新します。
OAuth API アクセス
OAuth API Access を有効にすると、アプリを使用する前にユーザーの認証が必要になります。この機能により、既存の認証メカニズム (例えば、Cookie ベースのユーザー名とパスワードによるログイン) を Developer Platform と統合することができます。
サンプルアプリケーション
その他の参考資料
