L’interface de ligne de commande Datadog permet de modifier les configurations des fonctions Lambda existantes pour instrumenter vos applications sans les redéployer. Il s’agit du moyen le plus rapide de tirer parti de la surveillance sans serveur de Datadog.

1. Installer l’interface de ligne de commande Datadog

   npm install -g @datadog/datadog-ci
   

2. Si vous commencez tout juste à utiliser la surveillance sans serveur Datadog, lancez l’interface de ligne de commande Datadog en mode interactif pour procéder rapidement à la première installation. Vous pouvez ignorer les autres étapes. Pour installer définitivement Datadog pour vos applications de production, ignorez cette étape et suivez les autres étapes afin d’exécuter la commande de l’interface de ligne de commande Datadog dans vos pipelines de CI/CD après un déploiement normal.

   datadog-ci lambda instrument -i
   

3. Configurer les identifiants AWS

   L’interface de ligne de commande Datadog nécessite un accès au service AWS Lambda et dépend du SDK JavaScript AWS pour résoudre les identifiants. Assurez-vous de configurer vos identifiants AWS à l’aide de la même méthode que celle utilisée lors de l’appel de l’interface de ligne de commande AWS.

4. Configurer le site Datadog

   export DATADOG_SITE="<DATADOG_SITE>"
   

   Remplacez <DATADOG_SITE> par (assurez-vous que le SITE sélectionné à droite est correct).

5. Configurer la clé d’API Datadog

   Datadog vous recommande d’enregistrer la clé d’API Datadog dans AWS Secrets Manager pour améliorer la sécurité et pour faciliter la rotation. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). Assurez-vous que vos fonctions Lambda disposent de l’autorisation IAM secretsmanager:GetSecretValue requise.

   export DATADOG_API_KEY_SECRET_ARN="<DATADOG_API_KEY_SECRET_ARN>"
   

   Pour effectuer un test rapide, vous pouvez également définir la clé d’API Datadog sous forme de texte brut :

   export DATADOG_API_KEY="<DATADOG_API_KEY>"
   

6. Instrumenter vos fonctions Lambda

   Remarque : instrumentez d’abord vos fonctions Lambda dans un environnement de type dev ou staging. Si les résultats de l’instrumentation ne vous conviennent pas, exécutez uninstrument avec les mêmes arguments pour annuler les modifications.

   Pour instrumenter vos fonctions Lambda, exécutez la commande suivante.

   datadog-ci lambda instrument -f <functionname> -f <another_functionname> -r <aws_region> -v 112 -e 59
   

   Renseignez les paramètres fictifs comme suit :

   • Remplacez <functionname> et <another_functionname> par les noms de vos fonctions Lambda. Vous pouvez également utiliser --functions-regex pour instrumenter automatiquement plusieurs fonctions dont les noms correspondent à l’expression régulière fournie.
   • Remplacez <aws_region> par le nom de la région AWS.

   Pour obtenir des paramètres supplémentaires, consultez la documentation relative à l’interface de ligne de commande.

Le plug-in Serverless Datadog configure vos fonctions afin qu’elles envoient des métriques, traces et logs à Datadog via l’extension Lambda Datadog.

Pour installer et configurer le plug-in Serverless Datadog, suivez les étapes suivantes :

1. Pour installer le plug-in Serverless Datadog :

   serverless plugin install --name serverless-plugin-datadog
   

2. Modifiez votre fichier serverless.yml :

   custom:
     datadog:
       site: <DATADOG_SITE>
       apiKeySecretArn: <DATADOG_API_KEY_SECRET_ARN>
   

   Renseignez les paramètres fictifs comme suit :

   • Remplacez <SITE_DATADOG> par (assurez-vous que le SITE sélectionné à droite est correct).
   • Remplacez <DATADOG_API_KEY_SECRET_ARN> par l’ARN du secret AWS où votre clé d’API Datadog est stockée en toute sécurité. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). L’autorisation secretsmanager:GetSecretValue est requise. Pour effectuer un test rapide, vous pouvez également utiliser apiKey et définir la clé d’API Datadog sous forme de texte brut.

   Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative au plug-in.

La macro CloudFormation Datadog transforme automatiquement votre modèle d’application SAM dans le but d’installer Datadog sur vos fonctions à l’aide des couches Lambda. De plus, elle configure vos fonctions afin qu’elles envoient des métriques, traces et logs à Datadog via l’extension Lambda Datadog.

1. Installer la macro CloudFormation Datadog

   Exécutez la commande suivante avec vos identifiants AWS pour déployer une pile CloudFormation qui installe la ressource AWS de la macro. Vous ne devez installer la macro qu’une seule fois par région de votre compte. Remplacez create-stack par update-stack pour installer la dernière version de la macro.

   aws cloudformation create-stack \
     --stack-name datadog-serverless-macro \
     --template-url https://datadog-cloudformation-template.s3.amazonaws.com/aws/serverless-macro/latest.yml \
     --capabilities CAPABILITY_AUTO_EXPAND CAPABILITY_IAM
   

   La macro est désormais déployée et utilisable.

2. Instrumenter vos fonctions Lambda

   Ajoutez la transformation DatadogServerless après la transformation AWS::Serverless sous la section Transform dans votre fichier template.yml.

   Transform:
     - AWS::Serverless-2016-10-31
     - Name: DatadogServerless
       Parameters:
         stackName: !Ref "AWS::StackName"
         nodeLayerVersion: 112
         extensionLayerVersion: 59
         site: "<DATADOG_SITE>"
         apiKeySecretArn: "<DATADOG_API_KEY_SECRET_ARN>"
   

   Renseignez les paramètres fictifs comme suit :

   • Remplacez <SITE_DATADOG> par (assurez-vous que le SITE sélectionné à droite est correct).
   • Remplacez <DATADOG_API_KEY_SECRET_ARN> par l’ARN du secret AWS où votre clé d’API Datadog est stockée en toute sécurité. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). L’autorisation secretsmanager:GetSecretValue est requise. Pour effectuer un test rapide, vous pouvez utiliser apiKey et définir la clé d’API Datadog sous forme de texte brut.

   Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative à la macro.

La bibliothèque CDK Construct Datadog installe automatiquement Datadog sur vos fonctions à l’aide des couches Lambda. De plus, elle configure vos fonctions afin qu’elles envoient des métriques, traces et logs à Datadog via l’extension Lambda Datadog.

1. Installer la bibliothèque CDK Construct Datadog

   # For AWS CDK v1
   npm install datadog-cdk-constructs --save-dev
   
   # For AWS CDK v2
   npm install datadog-cdk-constructs-v2 --save-dev
   

2. Instrumenter vos fonctions Lambda

   // For AWS CDK v1
   import { Datadog } from "datadog-cdk-constructs";
   
   // For AWS CDK v2
   import { Datadog } from "datadog-cdk-constructs-v2";
   
   const datadog = new Datadog(this, "Datadog", {
       nodeLayerVersion: 112,
       extensionLayerVersion: 59,
       site: "<DATADOG_SITE>",
       apiKeySecretArn: "<DATADOG_API_KEY_SECRET_ARN>"
   });
   datadog.addLambdaFunctions([<LAMBDA_FUNCTIONS>])
   

   Renseignez les paramètres fictifs comme suit :

   • Remplacez <SITE_DATADOG> par (assurez-vous que le SITE sélectionné à droite est correct).
   • Remplacez <DATADOG_API_KEY_SECRET_ARN> par l’ARN du secret AWS où votre clé d’API Datadog est stockée en toute sécurité. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). L’autorisation secretsmanager:GetSecretValue est requise. Pour effectuer un test rapide, vous pouvez utiliser apiKey et définir la clé d’API Datadog sous forme de texte brut.

   Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative à la bibliothèque CDK Datadog.

1. Installer la bibliothèque Lambda Datadog

   Si vous déployez votre fonction Lambda en tant qu’image de conteneur, vous ne pourrez pas utiliser la bibliothèque Lambda Datadog en tant que couche Lambda. À la place, il vous faudra grouper la bibliothèque Lambda Datadog et les bibliothèques de tracing dans l’image.

   npm install datadog-lambda-js dd-trace
   

   Veuillez noter que la version mineure du package datadog-lambda-js correspond toujours à la version de la couche. Par exemple, datadog-lambda-js v0.5.0 correspond au contenu de la version 5 de la couche.

2. Installer l’extension Lambda Datadog

   Ajoutez l’extension Lambda Datadog à votre image de conteneur en ajoutant ce qui suit à votre Dockerfile :

   COPY --from=public.ecr.aws/datadog/lambda-extension:<TAG> /opt/extensions/ /opt/extensions
   

   Remplacez <TAG> par un numéro de version spécifique (par exemple, 59) ou par latest. Il en va de même pour Alpine : indiquez un numéro de version spécifique (par exemple, 59-alpine) ou latest-alpine. Consultez le référentiel Amazon ECR pour découvrir la liste complète des tags autorisés.

3. Rediriger la fonction du gestionnaire

   • Définissez la valeur CMD de votre image sur node_modules/datadog-lambda-js/dist/handler.handler. Vous pouvez effectuer cette opération dans AWS ou directement dans votre Dockerfile. Notez que la valeur définie dans AWS remplace celle définie dans le Dockerfile, si vous avez défini les deux.
   • Définissez la variable d’environnement DD_LAMBDA_HANDLER sur votre gestionnaire d’origine, comme myfunc.handler.
   • Si vous utilisez ESModule avec le conteneur, vous devrez supprimer le fichier handler.js. Ce dernier existe pour Node 12 et sera supprimé lorsque AWS ne prendra plus en charge Node 12.

     RUN rm node_modules/datadog-lambda-js/dist/handler.js
     CMD ["node_modules/datadog-lambda-js/dist/handler.handler"]
     

   Remarque : si votre fonction Lambda s’exécute sur arm64, vous devez créer votre image de conteneur dans un environnement Amazon Linux basé sur arm64 ou appliquer le wrapper Datadog dans le code de votre fonction. Vous devrez peut-être procéder de la sorte si vous utilisez un outil de sécurité ou de surveillance tiers qui n’est pas compatible avec la redirection du gestionnaire Datadog.

4. Configurer la clé d’API et le site Datadog

   • Définissez la variable d’environnement DD_SITE sur (assurez-vous que le SITE sélectionné à droite est correct).
   • Définissez la variable d’environnement DD_API_KEY_SECRET_ARN sur l’ARN du secret AWS où votre clé d’API Datadog est stockée en toute sécurité. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). L’autorisation secretsmanager:GetSecretValue est requise. Pour effectuer un test rapide, vous pouvez également utiliser DD_API_KEY et définir la clé d’API Datadog sous forme de texte brut.

Pour utiliser Terraform, incorporez votre gestionnaire de fonction Lambda avec la bibliothèque Lambda Datadog. Définissez le gestionnaire de votre fonction sur la fonction de gestion de Datadog, à savoir /opt/nodejs/node_modules/datadog-lambda-js/handler.handler.

Utilisez le format suivant pour votre ressource Terraform :

resource "aws_lambda_function" "lambda" {
  "function_name" = ...
  ...

  # Assurez-vous de choisir les couches adéquates en fonction de votre architecture Lambda et de vos régions

  layers = [
    <ARN_TRACEUR_DATADOG>,
    <ARN_EXTENSION_DATADOG>
  ]

  handler = "/opt/nodejs/node_modules/datadog-lambda-js/handler.handler"

  environment {
    variables = {
      DD_SITE                     = <SITE_DATADOG>
      DD_API_KEY_SECRET_ARN       = <CLÉ_API>
      DD_LAMBDA_HANDLER           = <GESTIONNAIRE_LAMBDA>
    }
  }
}

Renseignez les variables adéquates :

1. Remplacez <ARN_TRACEUR_DATADOG> par l’ARN du traceur Datadog adéquat en fonction de votre type de région :

   AWS REGIONS	LAYERS
   Commercial	arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-<RUNTIME>:112
   GovCloud	arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-<RUNTIME>:112

   Dans l’ARN, remplacez <AWS_REGION> par une région AWS valide, comme us-east-1. Remplacez <RUNTIME> par l’une des valeurs suivantes : Node16-x, Node18-x, Node20-x.

2. Remplacez <ARN_EXTENSION_DATADOG> par l’ARN de l’extension Lambda Datadog adéquate en fonction de votre région et de votre architecture.

   AWS REGIONS	ARCHITECTURE	LAYERS
   Commercial	x86_64	arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension:59
   	arm64	arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension-ARM:59
   GovCloud	x86_64	arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension:59
   	arm64	arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension-ARM:59

3. Remplacez <SITE_DATADOG> par (assurez-vous que le SITE sélectionné à droite est correct).

4. Remplacez CLÉ_API par l’ARN du secret AWS où votre clé d’API Datadog est stockée de façon sécurisée. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). L’autorisation secretsmanager:GetSecretValue est requise. Pour effectuer un test rapide, vous pouvez également utiliser DD_API_KEY au lieu de DD_API_KEY_SECRET_ARN et définir la valeur sur votre clé d’API Datadog sous forme de texte brut.

5. Remplacez GESTIONNAIRE_LAMBDA par votre gestionnaire d’origine, par exemple myfunc.handler.

Exemple complet

resource "aws_lambda_function" "lambda" {
  "function_name" = ...
  ...

  # Veiller à choisir les couches adéquates en fonction de votre architecture Lambda et de vos régions AWS

  layers = [
    "arn:aws:lambda:us-east-1:464622532012:layer:Datadog-Node20-x:112",
    "arn:aws:lambda:us-east-1:464622532012:layer:Datadog-Extension:59"
  ]

  handler = "/opt/nodejs/node_modules/datadog-lambda-js/handler.handler"

  environment {
    variables = {
      DD_SITE                     = datadoghq.com
      DD_API_KEY_SECRET_ARN       = "arn:aws..."
      DD_LAMBDA_HANDLER           = "myfunc.handler"
    }
  }
}

• Définissez la variable d’environnement DD_LAMBDA_HANDLER sur votre gestionnaire d’origine, comme myfunc.handler.

1. Installer la bibliothèque Lambda Datadog

   La bibliothèque Lambda Datadog peut être importée en tant que couche (conseillé) OU en tant que package JavaScript.

   La version mineure du packdatadog-lambda-js correspond toujours à la version de la couche. Par exemple, datadog-lambda-js v0.5.0 correspond au contenu de la version 5 de la couche.

   • Option A : configurez les couches pour votre fonction Lambda à l’aide de l’ARN, en respectant le format ci-dessous :

     # Use this format for AWS commercial regions
     arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-<RUNTIME>:112
     
     # Use this format for AWS GovCloud regions
     arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-<RUNTIME>:112
     

     Remplacez <AWS_REGION> par une région AWS valide, comme us-east-1. Voici la liste des options disponibles pour <RUNTIME> : Node16-x, Node18-x, Node20-x.

   • Option B : si vous ne pouvez pas utiliser la couche Lambda Datadog prédéfinie, vous avez la possibilité d’installer les packages datadog-lambda-js via dd-trace via le gestionnaire de packages de votre choix.

     npm install datadog-lambda-js dd-trace
     

2. Installer l’extension Lambda Datadog

   Configurez les couches pour votre fonction Lambda à l’aide de l’ARN, en respectant le format suivant :

   # Use this format for x86-based Lambda deployed in AWS commercial regions
   arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension:59
   
   # Use this format for arm64-based Lambda deployed in AWS commercial regions
   arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension-ARM:59
   
   # Use this format for x86-based Lambda deployed in AWS GovCloud regions
   arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension:59
   
   # Use this format for arm64-based Lambda deployed in AWS GovCloud regions
   arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension-ARM:59
   

   Remplacez <AWS_REGION> par une région AWS valide, telle que us-east-1.

3. Rediriger la fonction du gestionnaire

   • Définissez le gestionnaire de votre fonction sur /opt/nodejs/node_modules/datadog-lambda-js/handler.handler si vous utilisez la couche, ou sur node_modules/datadog-lambda-js/dist/handler.handler si vous utilisez le package.
   • Définissez la variable d’environnement DD_LAMBDA_HANDLER sur votre gestionnaire d’origine, comme myfunc.handler.

   Remarque : si votre fonction Lambda s’exécute sur arm64 et si la bibliothèque datadog-lambda-js est installée en tant que package NPM (option B de l’étape 1), vous devez appliquer le wrapper Datadog dans le code de votre fonction. Par ailleurs, vous devrez peut-être procéder de la sorte si vous utilisez un outil de sécurité ou de surveillance tiers qui n’est pas compatible avec la redirection du gestionnaire Datadog.

4. Configurer la clé d’API et le site Datadog

   • Définissez la variable d’environnement DD_SITE sur (assurez-vous que le SITE sélectionné à droite est correct).
   • Définissez la variable d’environnement DD_API_KEY_SECRET_ARN sur l’ARN du secret AWS où votre clé d’API Datadog est stockée en toute sécurité. La clé doit être stockée sous forme de chaîne de texte brut (et non en tant que blob JSON). L’autorisation secretsmanager:GetSecretValue est requise. Pour effectuer un test rapide, vous pouvez également utiliser DD_API_KEY et définir la clé d’API Datadog sous forme de texte brut.