Datadog recommande aux développeurs d’utiliser le plug-in Serverless Framework s’ils se servent de ce framework pour déployer des applications sans serveur. Le plug-in active automatiquement l’instrumentation de vos applications afin de recueillir des métriques, des traces et des logs. Pour y parvenir, il effectue les opérations suivantes :

• Il installe la bibliothèque Lambda Datadog pour vos fonctions Lambda en tant que couche Lambda.
• Il installe l’extension Lambda Datadog pour vos fonctions Lambda en tant que couche Lambda (addExtension) ou abonne le Forwarder Datadog aux groupes de logs de votre fonction Lambda (forwarderArn).
• Il apporte les modifications nécessaires à la configuration de vos fonctions Lambda, en ajoutant par exemple des variables d’environnement ou des couches de tracing supplémentaires à vos fonctions Lambda.

Prise en main

Pour vous lancer rapidement, suivez les instructions d’installation pour Python, Node.js, Ruby, Java, Go ou .NET et consultez les métriques optimisées, les traces et les logs de votre fonction dans Datadog.

Une fois l’installation terminée, configurez les options avancées en fonction de vos besoins en matière de surveillance.

Mise à niveau

Chaque version du plug-in est publiée avec un ensemble précis de versions des couches Lambda Datadog. Pour bénéficier des nouvelles fonctionnalités et corrections de bugs proposées par les versions les plus récentes des couches Lambda Datadog, mettez à niveau le plug-in Serverless Framework. Testez la nouvelle version avant de la déployer sur vos applications en production.

Paramètres de configuration

Pour configurer plus d’options pour votre plug-in, utilisez les paramètres personnalisés suivants dans votre fichier serverless.yml :

Pour utiliser l’un de ces paramètres, ajoutez une section custom > datadog dans votre fichier serverless.yml semblable à l’exemple ci-dessous :

custom:
  datadog:
    apiKeySecretArn: "{Datadog_API_Key_Secret_ARN}"
    enableXrayTracing: false
    enableDDTracing: true
    enableDDLogs: true
    subscribeToAccessLogs: true
    forwarderArn: arn:aws:lambda:us-east-1:000000000000:function:datadog-forwarder
    exclude:
      - dd-excluded-function

Webpack

Si vous utilisez un bundler tel que webpack, consultez Tracing sans serveur et webpack.

TypeScript

Il se peut que vous rencontriez une erreur en raison de définitions de type manquantes. Pour résoudre cette erreur, ajoutez datadog-lambda-js et dd-trace à la liste devDependencies du fichier package.json de votre projet.

Si vous utilisez serverless-typescript, assurez-vous que serverless-datadog est bien placé au-dessus de l’entrée serverless-typescript dans votre fichier serverless.yml. Le plug-in détecte automatiquement les fichiers .ts.

plugins:
  - serverless-plugin-datadog
  - serverless-typescript

Désactiver le plug-in pour un environnement spécifique

SI vous souhaitez désactiver le plug-in en fonction de l’environnement (transmis via --stage), vous pouvez vous baser sur l’exemple ci-dessous :

provider:
  stage: ${self:opt.stage, 'dev'}

custom:
  staged: ${self:custom.stageVars.${self:provider.stage}, {}}

  stageVars:
    dev:
      dd_enabled: false

  datadog:
    enabled: ${self:custom.staged.dd_enabled, true}

Monitors sans serveur

Il existe sept monitors recommandés avec des valeurs par défaut prédéfinies.

Activer et configurer un monitor sans serveur recommandé

Pour créer un monitor sans serveur recommandé, vous devez utiliser son ID. Attention : vous devez également définir les paramètres DATADOG_API_KEY et DATADOG_APP_KEY dans votre environnement.

Si vous souhaitez configurer davantage de paramètres pour un monitor recommandé, définissez leur valeur sous l’ID du monitor sans serveur. Les paramètres qui ne sont pas spécifiés à cet endroit seront définis sur la valeur recommandée par défaut. Le paramètre query pour les monitors recommandés ne peut pas être modifié directement. Il prend donc la valeur par défaut, comme les autres paramètres non spécifiés. Toutefois, vous pouvez modifier la valeur seuil de query en la redéfinissant dans le paramètre options. Pour supprimer un monitor, retirez-le du modèle serverless.yml. Pour en savoir plus sur la définition des paramètres de monitor, consultez la documentation relative aux API Monitors de Datadog.

La création du monitor a lieu après le déploiement de la fonction. Si jamais elle échoue, le déploiement de la fonction n’est donc pas perturbé.

Créer un monitor recommandé avec les valeurs par défaut

Définissez l’ID du monitor sans serveur de votre choix, sans spécifier de valeur pour les paramètres.

custom:
  datadog:
    addLayers: true
    monitors:
      - high_error_rate:

Configurer un monitor recommandé

custom:
  datadog:
    addLayers: true
    monitors:
      - high_error_rate:
          name: "Taux d'erreur élevé avec seuil d'avertissement modifié"
          message: "Plus de 10 % des appels de la fonction ont entraîné des erreurs lors de l'intervalle sélectionné. Prévenir @data.dog@datadoghq.com @slack-serverless-monitors"
          tags: ["modified_error_rate", "serverless", "error_rate"]
          require_full_window: true
          priority: 2
          options:
            include_tags: true
            notify_audit: true
            thresholds:
              ok: 0.025
              warning: 0.05
              critical: 0.1

Supprimer un monitor

Pour supprimer un monitor, supprimez l’ID du monitor sans serveur et ses paramètres.

Activer et configurer un monitor personnalisé

Pour créer un monitor personnalisé, vous devez définir une chaîne d’ID de monitor sans serveur unique et transmettre la clé d’API et la clé d’application (DATADOG_API_KEY et DATADOG_APP_KEY) dans votre environnement. Le paramètre query est requis, mais tous les autres sont facultatifs. Définissez une chaîne d’ID de moniteur sans serveur unique et spécifiez les paramètres de votre choix ci-dessous. Pour en savoir plus sur les paramètres de monitor, consultez la documentation relative aux API Monitors de Datadog.

custom:
  datadog:
    addLayers: true
    monitors:
      - custom_monitor_id:
          name: "Monitor personnalisé"
          query: "max(next_1w):forecast(avg:system.load.1{*}, 'linear', 1, interval='60m', history='1w', model='default') >= 3"
          message: "Message personnalisé pour le monitor personnalisé. Prévenir @data.dog@datadoghq.com @slack-serverless-monitors"
          tags: ["custom_monitor", "serverless"]
          priority: 3
          options:
            enable_logs_sample: true
            require_full_window: true
            include_tags: false
            notify_audit: true
            notify_no_data: false
            thresholds:
              ok: 1
              warning: 2
              critical: 3

Changements majeurs

v5.0.0

• Lorsqu’il est utilisé avec l’extension Datadog, ce plug-in permet de définir les tags service et env par l’intermédiaire des variables d’environnement et non via tags de ressource Lambda.
• Le paramètre enableTags a été remplacé par les nouveaux paramètres service et env.

v4.0.0

• Par défaut, les données de télémétrie sont désormais transmises à Datadog à l’aide de l’extension Lambda Datadog.

Créer un ticket

Si vous rencontrez un bug avec ce package, faites-le-nous savoir en créant un ticket. Avant de créer un ticket, vérifiez que le problème n’a pas déjà été signalé dans les tickets existants pour éviter les doublons.

Lorsque vous créez un ticket, indiquez la version de Serverless Framework, la version de Python/Node.js et la stack trace, si possible. Indiquez aussi les étapes à reproduire le cas échéant.

Vous pouvez également créer un ticket pour demander l’ajout d’une fonctionnalité.

Contributions

Si vous rencontrez un problème avec ce package et que vous avez un correctif, faites une pull request en suivant la procédure.

Communauté

Si vous avez des commentaires ou des questions concernant les fonctionnalités, rejoignez le canal #serverless de la communauté Slack Datadog.

Licence

Sauf indication contraire, tous les fichiers de ce référentiel sont distribués sous licence Apache version 2.0.

Ce produit inclut un logiciel développé par Datadog (https://www.datadoghq.com/). Copyright 2021 Datadog, Inc.