Si vous ne l’avez pas encore fait, installez l'intégration AWS. Datadog pourra ainsi ingérer les métriques Lambda depuis AWS. Après avoir installé l'intégration AWS, suivez ces étapes pour instrumenter votre application afin d’envoyer des métriques, des logs et des traces à Datadog.
Si vos fonctions Lambda sont écrites en code Python 3.6 ou version antérieure, si vous avez déjà configuré la fonction Serverless de Datadog à l’aide du Forwarder Datadog, ou si vos fonctions Lambda sont déployées dans la région AWS GovCloud, reportez-vous aux instructions d’installation disponibles ici.
Le plug-in Serverless Datadog ajoute automatiquement la bibliothèque Lambda Datadog à vos fonctions à l’aide des couches Lambda, et configure vos fonctions de sorte à ce qu’elles envoient les métriques, les traces et les logs à Datadog via l'extension Lambda Datadog.
Pour installer et configurer le plug-in Serverless Datadog, suivez les étapes suivantes :
yarn add --dev serverless-plugin-datadog
serverless.yml :plugins:
- serverless-plugin-datadog
serverless.yml :custom:
datadog:
addExtension: true
apiKey: # Your Datadog API Key goes here.
Recherchez votre clé d’API Datadog sur la page de gestion des API. Pour prendre connaissance des paramètres supplémentaires, consultez la documentation du plug-in.
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 des couches. De plus, elle configure vos fonctions de sorte à ce qu’elles envoient des métriques, des traces et des logs à Datadog via l'extension Lambda 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 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.
Pour instrumenter une fonction, ajoutez ce qui suit dans la section Transform de votre fichier template.yml, après la transformation AWS::Serverless pour SAM.
Transform:
- AWS::Serverless-2016-10-31
- Name: DatadogServerless
Parameters:
stackName: !Ref "AWS::StackName"
nodeLayerVersion: "<VERSION_COUCHE>"
extensionLayerVersion: "<VERSION_EXTENSION>"
service: "<SERVICE>" # Facultatif
env: "<ENV>" # Facultatif
Remplacez <SERVICE> et <ENV> par les valeurs appropriées, <VERSION_COUCHE> par la version de votre choix de la bibliothèque Lambda Datadog, et <VERSION_EXTENSION> par la version de votre choix de l’extension Lambda Datadog.
Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative à la macro.
La bibliothèque CDK Constructs Datadog ajoute automatiquement la bibliothèque Lambda Datadog à vos fonctions à l’aide des couches Lambda, et configure vos fonctions de sorte à ce qu’elles envoient les métriques, les traces et les logs à Datadog via l'extension Lambda Datadog.
Exécutez la commande suivante dans votre projet CDK :
#PyPI
pip install datadog-cdk-constructs
Importez le module datadog-cdk-construct dans votre application AWS CDK et ajoutez les configurations suivantes :
from datadog_cdk_constructs import Datadog
datadog = Datadog(self, "Datadog",
python_layer_version=<VERSION_COUCHE>,
extension_layer_version=<VERSION_COUCHE_EXTENSION>,
dd_api_key=<CLÉ_API_DATADOG>
)
datadog.add_lambda_functions([<FONCTIONS_LAMBDA>])
Pour remplir les paramètres fictifs, procédez comme suit :
<CLÉ_API_DATADOG> par votre clé d’API Datadog, disponible sur la page de gestion des API.<VERSION_COUCHE> par la version de votre choix de la couche Lambda Datadog (consultez les dernières versions).<VERSION_EXTENSION> par la version de votre choix de l’extension Lambda Datadog (consultez les dernières versions).Pour en savoir plus et obtenir des paramètres supplémentaires, consultez la page NPM relative au CDK Datadog (en anglais).
zappa_settings.json :```json
{
"dev": {
"layers": ["arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-<RUNTIME>:<LIBRARY_VERSION>", "arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension:<EXTENSION_VERSION>"],
"lambda_handler": "datadog_lambda.handler.handler",
"aws_environment_variables": {
"DD_LAMBDA_HANDLER": "handler.lambda_handler",
"DD_TRACE_ENABLED": "true",
"DD_FLUSH_TO_LOG": "true",
"DD_API_KEY": "<DATADOG_API_KEY>",
},
}
}
```
```json
{
"dev": {
"layers": ["arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-<RUNTIME>:<LIBRARY_VERSION>", "arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension:<EXTENSION_VERSION>"],
"lambda_handler": "datadog_lambda.handler.handler",
"aws_environment_variables": {
"DD_LAMBDA_HANDLER": "handler.lambda_handler",
"DD_TRACE_ENABLED": "true",
"DD_FLUSH_TO_LOG": "true",
"DD_API_KEY": "<DATADOG_API_KEY>",
},
}
}
```
<AWS_REGION> par la région AWS où vos fonctions Lambda sont déployées.<RUNTIME> par le runtime Python approprié. Les options RUNTIME disponibles sont Python27, Python36, Python37 et Python38.<LIBRARY_VERSION> par la dernière version de la bibliothèque Lambda Datadog.<EXTENSION_VERSION> par la dernière version de l’extension Lambda Datadog.<DATADOG_API_KEY> par votre clé d’API Datadog, disponible sur la page de gestion des API.Par exemple :
```
arn:aws:lambda:us-east-1:464622532012:layer:Datadog-Python38:36
arn:aws:lambda:us-east-1:464622532012:layer:Datadog-Extension:7
```
```
arn:aws-us-gov:lambda:us-gov-east-1:002406178527:layer:Datadog-Python38:36
arn:aws-us-gov:lambda:us-gov-east-1:002406178527:layer:Datadog-Extension:7
```
config.json :```json
{
"version": "2.0",
"app_name": "hello-chalice",
"stages": {
"dev": {
"api_gateway_stage": "api",
"environment_variables": {
"DD_TRACE_ENABLED": "true",
"DD_FLUSH_TO_LOG": "true",
"DD_API_KEY": "<DATADOG_API_KEY>",
},
"layers": ["arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension:<EXTENSION_VERSION>"],
}
}
}
```
```json
{
"version": "2.0",
"app_name": "hello-chalice",
"stages": {
"dev": {
"api_gateway_stage": "api",
"environment_variables": {
"DD_TRACE_ENABLED": "true",
"DD_FLUSH_TO_LOG": "true",
"DD_API_KEY": "<DATADOG_API_KEY>",
},
"layers": ["arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension:<VERSION_NUMBER>"],
}
}
}
```
<DATADOG_API_KEY> par votre clé d’API Datadog, disponible sur la page de gestion des API.<AWS_REGION> par la région AWS où vos fonctions Lambda sont déployées.<EXTENSION_VERSION> par la dernière version de l’extension Lambda Datadog.datadog_lambda à votre fichier requirements.txt.datadog_lambda_wrapper en tant que middleware dans app.py :from chalice import Chalice, ConvertToMiddleware
from datadog_lambda.wrapper import datadog_lambda_wrapper
app = Chalice(app_name='hello-chalice')
app.register_middleware(ConvertToMiddleware(datadog_lambda_wrapper))
@app.route('/')
def index():
return {'hello': 'world'}
Utilisez l’interface de ligne de commande Datadog pour configurer l’instrumentation sur vos fonctions Lambda dans vos pipelines CI/CD. La commande de l’interface de ligne de commande ajoute automatiquement la bibliothèque Lambda Datadog à vos fonctions à l’aide des couches Lambda. Elle configure vos fonctions de façon à envoyer des métriques, traces et logs à Datadog.
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
Pour instrumenter la fonction, exécutez la commande suivante avec vos identifiants AWS. Remplacez <nomfonction> et <autre_nomfonction> par les noms de vos fonctions Lambda, <région_aws> par le nom de la région AWS, <version_couche> par la version de votre choix de la bibliothèque Lambda Datadog et <version_extension> par la version de votre choix de l’extension Lambda Datadog.
datadog-ci lambda instrument -f <nomfonction> -f <autre_nomfonction> -r <région_aws> -v <version_couche> -e <version_extension>
Par exemple :
datadog-ci lambda instrument -f my-function -f another-function -r us-east-1 -v 19 -e 8
datadog-ci lambda instrument -f my-function -f another-function -r us-east-1 -v 19 -e 8
Pour obtenir plus de détails ainsi que des paramètres supplémentaires, consultez la documentation relative à l’interface de ligne de commande.
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.
pip install datadog-lambda
Veuillez noter que la version mineure du package datadog-lambda correspond toujours à la version de la couche. Par exemple, datadog-lambda v0.5.0 correspond au contenu de la version 5 de la couche.
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, 7) ou par latest. Accédez au référentiel Amazon ECR pour consulter la liste complète des tags disponibles.
CMD de votre image sur datadog_lambda.handler.handler. Vous pouvez effectuer cette opération dans AWS ou directement dans votre Dockerfile. Notez que la valeur définie dans AWS remplace la valeur définie dans le Dockerfile, si vous avez défini les deux.DD_LAMBDA_HANDLER sur votre gestionnaire d’origine, par exemple myfunc.handler.DD_TRACE_ENABLED sur true.DD_API_KEY sur votre clé d’API Datadog, disponible sur la page de gestion des API.service et env avec les valeurs appropriées dans votre fonction.Vous pouvez installer la bibliothèque Lambda Datadog en tant que couche (option recommandée) ou en tant que package Python.
La version mineure du package datadog-lambda correspond toujours à la version de la couche. Par exemple, datadog-lambda v0.5.0 correspond au contenu de la version 5 de la couche.
Configurez les couches pour votre fonction Lambda à l’aide de l’ARN, en respectant le format suivant :
arn:aws:lambda:<RÉGION_AWS>:464622532012:layer:Datadog-<RUNTIME>:<VERSION>
arn:aws-us-gov:lambda:<RÉGION_AWS>:002406178527:layer:Datadog-<RUNTIME>:<VERSION>
Les options RUNTIME disponibles sont Python27, Python36, Python37 et Python38. Pour VERSION, consultez la dernière version. Exemple :
arn:aws:lambda:us-east-1:464622532012:layer:Datadog-Python37:19
arn:aws-us-gov:lambda:us-gov-east-1:002406178527:layer:Datadog-Python37:19
Installez datadog-lambda et ses dépendances localement dans le dossier du projet de votre fonction. Remarque : datadog-lambda dépend de ddtrace, qui a recours à des extensions natives ; ces extensions doivent donc être installées et compilées dans un environnement Linux. Par exemple, vous pouvez utiliser dockerizePip pour le plug-in Serverless Framework et –use-container pour AWS SAM. Pour en savoir plus, consultez la documentation relative à l’ajout de dépendances à votre package de déploiement de fonction.
pip install datadog-lambda -t ./
Consultez la dernière version.
Configurez les couches pour votre fonction Lambda à l’aide de l’ARN, en respectant le format suivant :
arn:aws:lambda:<RÉGION_AWS>:464622532012:layer:Datadog-Extension:<VERSION_EXTENSION>
arn:aws-us-gov:lambda:<RÉGION_AWS>:002406178527:layer:Datadog-Extension:<VERSION_EXTENSION>
Pour VERSION_EXTENSION, consultez la dernière version.
Pour configurer la fonction, suivez les étapes ci-dessous :
datadog_lambda.handler.handler.DD_LAMBDA_HANDLER sur votre gestionnaire d’origine, comme myfunc.handler.DD_TRACE_ENABLED sur true.DD_API_KEY sur votre clé d’API Datadog, disponible sur la page de gestion des API.service et env pour votre fonction avec des valeurs correspondantes.Après avoir configuré votre fonction en suivant la procédure ci-dessus, vous pouvez visualiser vos métriques, logs et traces sur la page Serverless principale.
Bien que cette opération soit facultative, Datadog vous recommande fortement d’ajouter les tags env, service et version à vos applications sans serveur. Pour ce faire, suivez la documentation relative au tagging de service unifié.
Les logs d’un environnement sans serveur générés par des ressources gérées (outre les fonctions Lambda AWS) peuvent être très utiles pour identifier la cause d’origine des problèmes liés à vos applications sans serveur. Nous vous conseillons de transmettre les logs associés à vos ressources gérées suivantes :
Pour collecter des logs depuis des ressources AWS autres que des fonctions Lambda, installez le Forwarder Datadog et configurez-le de façon à l’abonner à tous les groupes de logs CloudWatch des ressources gérées.
Si vous souhaitez envoyer une métrique custom ou une span personnalisée, consultez l’exemple de code ci-dessous :
import time
from ddtrace import tracer
from datadog_lambda.metric import lambda_metric
def lambda_handler(event, context):
# ajouter des tags personnalisés à la span de la fonction Lambda,
# ne fonctionne PAS lorsque le tracing X-Ray est activé
current_span = tracer.current_span()
if current_span:
current_span.set_tag('customer.id', '123456')
# envoyer une span personnalisée
with tracer.trace("hello.world"):
print('Hello, World!')
# envoyer une métrique custom
lambda_metric(
metric_name='coffee_house.order_value',
value=12.45,
timestamp=int (time.time()), # facultatif, doit correspondre aux 20 dernières minutes
tags=['product:latte', 'order:online']
)
return {
'statusCode': 200,
'body': get_message()
}
# tracer une fonction
@tracer.wrap()
def get_message():
return 'Hello from serverless!'
Pour en savoir plus sur l’envoi de métriques custom, consultez cette page. Pour obtenir plus d’informations sur l’instrumentation personnalisée, consultez la documentation dédiée.
Documentation, liens et articles supplémentaires utiles:
