Que sont les extensions de l’interface Datadog

Les extensions de l’interface permettent aux développeurs d’étendre les fonctionnalités natives de Datadog au moyen de widgets de dashboard personnalisés. Par exemple, si vous souhaitez utiliser une vue non prise en charge par Datadog ou un workflow de remédiation couramment exécuté dans une plateforme tierce, vous pouvez écrire une extension de l’interface pour ajouter cette fonctionnalité dans Datadog.

Configuration

Configurez votre environnement de développement local.

1. Créez une application Datadog pour votre extension d’interface :

   yarn create @datadog/app
   

2. Accédez au dossier que vous venez de créer :

   cd starter-kit
   

3. Configurez votre environnement de développement :

   yarn start
   

Cette commande lance votre serveur de développement local sur http://localhost:3000/.

Si vous voyez ce message, votre application est en cours d’exécution :

Notez qu’il y a deux pages :

• http://localhost:3000 : Un contrôleur principal qui assure l’orchestration de vos différentes extensions (comme les widgets, les menus ou les fenêtres contextuelles). Cette page s’avèrera utile lorsque vous aurez enrichi les fonctionnalités de votre App.
• http://localhost:3000/widget : Les composants des widgets, fenêtres contextuelles ou autres éléments qui nécessitent un affichage dédié.

Consultez le Guide d’utilisation de la plateforme de développement (en anglais) pour en savoir plus sur cette architecture.

Ajouter votre application à la plateforme des développeurs

1. Accédez à la Integrations > Developer Platform et cliquez sur + New App.

2. Saisissez un nom unique pour votre application.

3. Une fois que vous avez accès au dashboard de votre nouvelle application, vous pouvez choisir de modifier le nom choisi, de saisir une description plus détaillée, ou de modifier l’icône de l’application.

Ajouter votre App à un dashboard

1. Pour pouvoir ajouter votre App à un dashboard, vous devez d’abord l’activer en cliquant sur UI Extensions.

   Une fois cette vue chargée, cliquez sur le bouton Enable UI Extensions.

2. Une fois que vous avez accès à d’autres options pour votre application, modifiez les options Root URL et Debug Mode Root URL pour qu’elles correspondent à la version localhost du widget que vous utilisez. Le chemin du contrôleur principal est /widget. Ces valeurs d’URL changeront au fur et à mesure que vous construirez votre application et que vous commencerez à l’héberger sur votre propre infrastructure.

3. Activez l’option Dashboard Custom Widget. Cela génère un fichier JSON pour l’application.

   

   Dans cet exemple, la sortie JSON contient une valeur intitulée Your first widget. Il s’agit du nom de votre widget, qui apparaît dans le menu pour l’ajouter à vos dashboards.

4. Accédez à votre dashboard et ajoutez un widget.

   

5. La section Custom Widgets est située en bas de la barre latérale. Recherchez votre widget dans la liste, et ajoutez-le à votre dashboard.

   

6. Un aperçu de votre nouveau widget apparaît, ainsi que plusieurs options. Faites défiler la page et cliquez sur Done pour ajouter le widget à votre dashboard.

   

7. Pour créer le build de votre App, exécutez yarn build dans votre terminal. Ensuite, déplacez le site statique généré vers la plateforme d’hébergement de votre choix et mettez à jour les URL dans les paramètres de l’App.

Accès via API OAuth

Lorsque OAuth API Access est activé, les utilisateurs doivent s’authentifier pour pouvoir utiliser l’App. Vous avez la possibilité d’intégrer votre mécanisme d’authentification existant (par exemple, une connexion par nom d’utilisateur/mot de passe basée sur des cookies) à la Plateforme de développement.

Exemples d’App

• Starter kit
• Sentiment analysis

Pour aller plus loin

• En savoir plus sur la plateforme pour développeurs Datadog
• En savoir plus sur les extensions de l’interface