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.
Vous pouvez également ajouter la commande à vos pipelines de CI/CD pour instrumenter toutes vos applications sans serveur. Lancez la commande après le déploiement normal de votre application sans serveur, de sorte que les modifications apportées par l’interface de ligne de commande Datadog ne soient pas écrasées.
Installation
Installez l’interface de ligne de commande Datadog avec NPM ou Yarn :
# NPM
npm install -g @datadog/datadog-ci
# Yarn
yarn global add @datadog/datadog-ci
Instrumentation
Pour instrumenter la fonction, exécutez la commande suivante avec vos identifiants AWS :
datadog-ci lambda instrument -f <nomfonction> -f <autre_nomfonction> -r <région_aws> -v <version_couche> --forwarder <arn_forwarder>
Renseignez les paramètres fictifs comme suit :
- Remplacez
<nomfonction>
et <autre_nomfonction>
par les noms de vos fonctions Lambda. - Remplacez
<aws_region>
par le nom de la région AWS. - Remplacez
<version_couche>
par la version souhaitée de la bibliothèque Lambda Datadog. La dernière version est 117
. - Remplacez
<arn_forwarder>
par l’ARN du Forwarder (voir la documentation sur le Forwarder).
Par exemple :
datadog-ci lambda instrument -f my-function -f another-function -r us-east-1 -v 117 --forwarder "arn:aws:lambda:us-east-1:000000000000:function:datadog-forwarder"
Si votre fonction Lambda est configurée de façon à utiliser la signature de code, vous devez ajouter l’ARN du profil de signature de Datadog (arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc
) à la configuration de la signature de code de votre fonction avant de pouvoir l’instrumenter avec l’interface de ligne de commande Datadog.
Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative à l’interface de ligne de commande.
Le plug-in Serverless Datadog ajoute automatiquement la bibliothèque Lambda Datadog à vos fonctions à l’aide des couches. Il configure également vos fonctions de façon à envoyer des métriques, traces et logs à Datadog par l’intermédiaire du Forwarder Datadog.
Si votre fonction Lambda est configurée de façon à utiliser la signature de code, vous devez ajouter l’ARN du profil de signature de Datadog (arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc
) à la configuration de la signature de code de votre fonction avant d’installer le plug-in Serverless Datadog.
Pour installer et configurer le plug-in Serverless Datadog, suivez les étapes suivantes :
- Pour installer le plug-in Serverless Datadog :
yarn add --dev serverless-plugin-datadog
- Ajoutez ce qui suit dans votre fichier
serverless.yml
:plugins:
- serverless-plugin-datadog
- Ajoutez également la section suivante dans votre fichier
serverless.yml
:custom:
datadog:
forwarderArn: # The Datadog Forwarder ARN goes here.
Pour en savoir plus sur l’ARN du Forwarder Datadog ou sur l’installation, cliquez ici. Pour obtenir des paramètres supplémentaires, consultez la documentation du plug-in.
Remarque : si votre fonction Lambda utilise à la fois les bibliothèques de tracing de Datadog et le webpack, vous devez suivre ces étapes de configuration supplémentaires.
La macro CloudFormation Datadog transforme automatiquement votre modèle d’application SAM dans le but d’ajouter la bibliothèque Lambda Datadog à vos fonctions à l’aide de couches. Elle configure également vos fonctions de façon à envoyer des métriques, traces et logs à Datadog par l’intermédiaire du Forwarder Datadog.
Installation
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 mettre à jour la macro vers la dernière version.
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.
Instrumentation
Dans votre fichier template.yml
, ajoutez ce qui suit dans la section Transform
, après la transformation AWS::Serverless
pour SAM.
Transform:
- AWS::Serverless-2016-10-31
- Name: DatadogServerless
Parameters:
stackName: !Ref "AWS::StackName"
nodeLayerVersion: "117"
forwarderArn: "<ARN_FORWARDER>"
service: "<SERVICE>" # Facultatif
env: "<ENVIRONNEMENT>" # Facultatif
Renseignez les paramètres fictifs comme suit :
- Remplacez
<ARN_FORWARDER>
par l’ARN du Forwarder (voir la documentation sur le Forwarder). - Remplacez
<SERVICE>
et <ENVIRONNEMENT>
par votre service et votre environnement.
Si votre fonction Lambda est configurée de façon à utiliser la signature de code, vous devez ajouter l’ARN du profil de signature de Datadog (arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc
) à la configuration de la signature de code de votre fonction avant de pouvoir utiliser la macro.
Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative à la macro.
Les Constructs CDK Datadog configurent automatiquement l’ingestion des métriques, traces et logs provenant de vos applications sans serveur. Pour ce faire, ils suivent la procédure suivante :
- Installation et configuration de la bibliothèque Lambda Datadog pour vos fonctions Lambda Python et Node.js
- Activation de la collecte de traces et de métriques custom à partir de vos fonctions Lambda
- Gestion des abonnements du Forwarder Datadog aux groupes de logs de votre fonction Lambda
Installation
Exécutez la commande Yarn ou NPM suivante dans votre projet CDK pour installer la bibliothèque CDK Constructs Datadog :
#Yarn
yarn add --dev datadog-cdk-constructs
#NPM
npm install datadog-cdk-constructs --save-dev
Instrumentation
Pour instrumenter la fonction, importez le module datadog-cdk-construct
dans votre application AWS CDK et ajoutez les configurations suivantes (cet exemple est en TypeScript ; la logique est similaire dans d’autres langages) :
import * as cdk from "@aws-cdk/core";
import { Datadog } from "datadog-cdk-constructs";
class CdkStack extends cdk.Stack {
constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
const datadog = new Datadog(this, "Datadog", {
nodeLayerVersion: 117,
forwarderArn: "<ARN_FORWARDER>",
service: "<SERVICE>", // Facultatif
env: "<ENVIRONNEMENT>", // Facultatif
});
datadog.addLambdaFunctions([<FONCTIONS_LAMBDA>])
}
}
Renseignez les paramètres fictifs comme suit :
- Remplacez
<ARN_FORWARDER>
par l’ARN du Forwarder (voir la documentation sur le Forwarder). - Remplacez
<SERVICE>
et <ENVIRONNEMENT>
par votre service et votre environnement.
Si votre fonction Lambda est configurée de façon à utiliser la signature de code, vous devez ajouter l’ARN du profil de signature de Datadog (arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc
) à la configuration de la signature de code de votre fonction avant de pouvoir utiliser la macro.
Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la page NPM relative au CDK Datadog (en anglais).
Installation
Si vous déployez votre fonction Lambda en tant qu’image de conteneur, vous ne pouvez pas utiliser la bibliothèque Lambda Datadog en tant que couche Lambda. À la place, vous devez installer la bibliothèque Lambda Datadog en tant que dépendance de votre fonction directement dans l’image. Si vous utilisez le tracing Datadog, vous devez également installer dd-trace
.
NPM :
npm install --save datadog-lambda-js dd-trace
Yarn :
yarn add datadog-lambda-js dd-trace
Remarque : 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.
Pour configurer la fonction, suivez les étapes ci-dessous :
- 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. Remarque : la valeur définie dans AWS remplace la valeur définie dans le Dockerfile, si vous avez défini les deux. - Définissez les variables d’environnement suivantes dans AWS :
- Définissez
DD_LAMBDA_HANDLER
sur votre gestionnaire d’origine, par exemple myfunc.handler
. - Définissez
DD_TRACE_ENABLED
sur true
. - Définissez
DD_FLUSH_TO_LOG
sur true
.
- Si vous le souhaitez, ajoutez des tags
service
et env
avec les valeurs appropriées dans votre fonction.
Abonnement
Pour pouvoir envoyer des métriques, traces et logs à Datadog, abonnez la fonction Lambda du Forwarder Datadog à chaque groupe de logs de votre fonction.
- Si ce n’est pas déjà fait, installez le Forwarder Datadog.
- Abonnez le Forwarder Datadog aux groupes de logs de votre fonction.
Installation
La bibliothèque Lambda Datadog peut être importée en tant que couche ou en tant que package JavaScript.
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.
Utilisation de la couche
Configurez les couches pour votre fonction Lambda à l’aide de l’ARN en suivant le format suivant.
# Pour les régions us, us3, us5, eu et ap1
arn:aws:lambda:<RÉGION_AWS>:464622532012:layer:Datadog-<RUNTIME>:<VERSION>
# Pour les régions us-gov
arn:aws-us-gov:lambda:<RÉGION_AWS>:002406178527:layer:Datadog-<RUNTIME>:<VERSION>
Les options RUNTIME
disponibles sont Node16-x
, Node18-x
, Node20-x
, Node22-x
. La dernière VERSION
est 117
. Exemple :
arn:aws:lambda:us-east-1:464622532012:layer:Datadog-Node22-x:117
Si votre fonction Lambda est configurée de façon à utiliser la signature de code, vous devez ajouter l’ARN du profil de signature de Datadog (arn:aws:signer:us-east-1:464622532012:/signing-profiles/DatadogLambdaSigningProfile/9vMI9ZAGLc
) à la configuration de la signature de code de votre fonction avant de pouvoir ajouter la bibliothèque Lambda Datadog en tant que couche.
Utilisation du package
NPM :
npm install --save datadog-lambda-js
Yarn :
yarn add datadog-lambda-js
Consultez la dernière version.
Pour configurer la fonction, suivez les étapes ci-dessous :
- 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
. - Définissez la variable d’environnement
DD_TRACE_ENABLED
sur true
. - Définissez la variable d’environnement
DD_FLUSH_TO_LOG
sur true
. - Vous pouvez également définir des tags
service
et env
pour votre fonction avec des valeurs correspondantes.
Remarque : si votre fonction Lambda utilise à la fois les bibliothèques de tracing de Datadog et le webpack, vous devez suivre ces étapes de configuration supplémentaires.
Abonnement
Pour pouvoir envoyer des métriques, traces et logs à Datadog, abonnez la fonction Lambda du Forwarder Datadog à chaque groupe de logs de votre fonction.
- Si ce n’est pas déjà fait, installez le Forwarder Datadog.
- Abonnez le Forwarder Datadog aux groupes de logs de votre fonction.