Datadog recommande la macro Serverless CloudFormation pour les clients qui utilisent AWS SAM pour déployer leurs applications sans serveur.

La macro configure automatiquement l’ingestion de métriques, de traces et de logs depuis vos applications sans serveur en effectuant les opérations suivantes :

• Installation et configuration de la bibliothèque Lambda et de l’extension Lambda Datadog pour vos fonctions Lambda Python et Node.js.
• Activation de la collecte de métriques Lambda optimisées et de métriques custom depuis vos fonctions Lambda.
• Gestion des abonnements du Forwarder Datadog aux groupes de logs de votre fonction Lambda si vous le souhaitez.

Installation

Pour activer la macro dans votre compte AWS, vous devez déployer une stack CloudFormation avec un modèle fourni par Datadog. Ce déploiement comprend une ressource de macro CloudFormation et une fonction Lambda qui est invoquée lorsque la macro est exécutée. Le déploiement de cette stack vous permet d’utiliser la macro sur d’autres stacks CloudFormation déployées dans le même compte. Pour découvrir comment définir une macro dans votre compte, consultez la documentation de CloudFormation.

S’il s’agit d’une première installation, procédez au déploiement comme suit :

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

Si vous mettez à jour la macro après la sortie d’une nouvelle version, utilisez plutôt la méthode update-stack avec les mêmes paramètres. Vous pouvez également installer la version de votre choix en consultant la page des dernières versions et en remplaçant latest.yml par le nom de la version. Exemple : 0.1.2.yml.

aws cloudformation update-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

Remarque : il vous suffit de déployer la macro une fois pour une région donnée dans votre compte AWS pour pouvoir l’utiliser pour toutes les stacks CloudFormation déployées dans cette même région.

Utilisation avec AWS SAM

Pour déployer votre application sans serveur avec SAM, ajoutez la macro Serverless CloudFormation de Datadog dans la section Transform de votre fichier template.yml, après la transformation SAM requise :

Transform:
  - AWS::Serverless-2016-10-31
  - Name: DatadogServerless
    Parameters:
      stackName: !Ref "AWS::StackName"
      apiKey: "<CLÉ_API_DATADOG>"
      pythonLayerVersion: "<VERSION_COUCHE>" # Utiliser nodeLayerVersion pour Node.js
      extensionLayerVersion: "<VERSION_COUCHE>"
      service: "<SERVICE>" # Facultatif
      env: "<ENV>" # Facultatif
      # Pour des paramètres supplémentaires, consultez la section Configuration

Remarque : si vous n’avez pas modifié le fichier template.yml fourni lorsque vous avez installé la macro, le nom de la macro défini dans votre compte sera alors DatadogServerless. Si vous avez modifié le modèle d’origine, assurez-vous que le nom de la transformation que vous ajoutez ici correspond à celui indiqué dans la propriété Name de la ressource AWS::CloudFormation::Macro.

Configuration

Pour réaliser une configuration plus poussée de votre plug-in, utilisez les paramètres personnalisés suivants :

Fonctionnement

Cette macro modifie votre modèle CloudFormation pour installer la bibliothèque Lambda Datadog en associant les couches Lambda pour Node.js et Python à vos fonctions. Elle redirige vers un handler de remplacement qui initialise la bibliothèque Lambda sans aucune modification de code requise.

Dépannage

Logs de debugging

Pour débuguer les problèmes plus facilement, vous pouvez consulter les logs CloudWatch associés à la fonction Lambda de la macro. Pour trouver les logs CloudWatch :

• Recherchez la stack CloudFormation de la macro (qui s’appelle datadog-serverless-macro si vous avez copié la commande sous instructions)
• Lorsque vous cliquez sur l’onglet ressources, le groupe de logs CloudWatch devrait être disponible avec l’ID logique MacroFunctionLogGroup

Message d’erreur : ‘FunctionName’ property is undefined for…

Cette erreur se produit lorsque vous spécifiez un forwarderArn et que vous déployez votre fonction Lambda pour la première fois : aucun groupe de logs n’existe actuellement et la macro ne peut pas créer ce groupe de logs ni abonner le Forwarder au groupe. Pour corriger ce problème, vous pouvez définir explicitement la propriété FunctionName sur votre fonction Lambda (voir l’exemple ci-dessous).

Resources:
  MyLambda:
    Type: AWS::Serverless::Function
    Properties:
      Handler: index.handler
      Runtime: nodejs12.x
      FunctionName: MyFunctionName # Ajoutez cette propriété à vos fonctions Lambda

Si vous ne pouvez pas (ou ne souhaitez pas) définir la propriété FunctionName explicitement, supprimez le paramètre forwarderArn du modèle SAM ou du code source CDK, et définissez plutôt les filtres d’abonnement à l’aide de la ressource AWS::Logs::SubscriptionFilter comme indiqué ci-dessous.

Resources:
  MyLogSubscriptionFilter:
    Type: "AWS::Logs::SubscriptionFilter"
    Properties:
      DestinationArn: "<ARN_FORWARDER_DATADOG>"
      LogGroupName: "<NOM_GROUPE_LOGS_CLOUDWATCH>"
      FilterPattern: ""

Message d’erreur : ’logGroupNamePrefix’ failed to satisfy constraint…

L’option forwarderArn ne fonctionne pas lorsque FunctionName contient des fonctions CloudFormation, telles que !Sub. Dans ce cas, la macro n’a pas accès au nom réel de la fonction (CloudFormation exécute les fonctions après les transformations). Par conséquent, elle ne peut pas créer de groupes de logs ni de filtres d’abonnement pour vos fonctions.

Supprimez le paramètre forwarderArn du modèle SAM ou du code source CDK, et définissez plutôt les filtres d’abonnement à l’aide de la ressource AWS::Logs::SubscriptionFilter comme indiqué ci-dessous.

Resources:
  MyLogSubscriptionFilter:
    Type: "AWS::Logs::SubscriptionFilter"
    Properties:
      DestinationArn: "<ARN_FORWARDER_DATADOG>"
      LogGroupName: "<NOM_GROUPE_LOGS_CLOUDWATCH>"
      FilterPattern: ""

Communauté

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