Instrumenter des applications Ruby sans serveur
Si vous avez déjà configuré vos fonctions Lambda à l'aide du Forwarder Datadog, consultez la documentation relative à l'
instrumentation avec le Forwarder Datadog. Sinon, suivez les instructions fournies dans ce guide pour instrumenter vos applications avec l'extension Lambda Datadog.
Si vos fonctions Lambda sont déployées dans un VPC sans accès à Internet, vous pouvez transmettre des données avec
AWS PrivateLink pour le site
datadoghq.com Datadog ou avec
un proxy pour tous les autres sites.
Installation
Datadog propose de nombreuses méthodes différentes pour instrumenter vos applications sans serveur. Choisissez celle qui répond le mieux à vos besoins ci-dessous. Nous vous conseillons d’utiliser l’interface de ligne de commande Datadog. Vous devez suivre les instructions fournies dans l’onglet « Image de conteneur » si votre application est déployée en tant qu’image de conteneur.
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.
Configurer vos fonctions Lambda
Activez la solution APM Datadog et incorporez la fonction Lambda de votre gestionnaire à l’aide du wrapper fourni par la bibliothèque Lambda Datadog.
require 'datadog/lambda'
Datadog::Lambda.configure_apm do |c|
# Enable the instrumentation
end
def handler(event:, context:)
Datadog::Lambda.wrap(event, context) do
return { statusCode: 200, body: 'Hello World' }
end
end
Installer l’interface de ligne de commande Datadog
npm install -g @datadog/datadog-ci
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
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.
Configurer le site Datadog
export DATADOG_SITE="<DATADOG_SITE>"
Remplacez <DATADOG_SITE> par
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>"
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 20 -e 48
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 :
Configurer vos fonctions Lambda
Activez la solution APM Datadog et incorporez la fonction Lambda de votre gestionnaire à l’aide du wrapper fourni par la bibliothèque Lambda Datadog.
require 'datadog/lambda'
Datadog::Lambda.configure_apm do |c|
# Enable the instrumentation
end
def handler(event:, context:)
Datadog::Lambda.wrap(event, context) do
return { statusCode: 200, body: 'Hello World' }
end
end
Pour installer le plug-in Serverless Datadog :
serverless plugin install --name serverless-plugin-datadog
Modifiez votre fichier serverless.yml :
custom:
datadog:
site: <DATADOG_SITE>
apiKeySecretArn: <DATADOG_API_KEY_SECRET_ARN>
Renseignez les paramètres fictifs comme suit :
- Remplacez
<DATADOG_SITE> par - 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.
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, vous devrez intégrer la bibliothèque Lambda Datadog et les bibliothèques de tracing dans l’image.
Ajoutez ce qui suit à votre Gemfile :
gem 'datadog-lambda'
gem 'ddtrace'
ddtrace contient les extensions natives qui doivent être compilées pour que Amazon Linux fonctionne avec AWS Lambda.
Installez gcc, gmp-devel et make avant d’exécuter bundle install dans le Dockerfile de votre fonction, afin de vous assurer que les extensions natives peuvent être compilées.
FROM <base image>
# assemble your container image
RUN yum -y install gcc gmp-devel make
RUN bundle config set path 'vendor/bundle'
RUN bundle install
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, 48) ou par latest. Accédez au référentiel Amazon ECR pour consulter la liste complète des tags disponibles.
Configurer vos fonctions Lambda
Activez la solution APM Datadog et incorporez la fonction Lambda de votre gestionnaire à l’aide du wrapper fourni par la bibliothèque Lambda Datadog.
require 'datadog/lambda'
Datadog::Lambda.configure_apm do |c|
# Enable the instrumentation
end
def handler(event:, context:)
Datadog::Lambda.wrap(event, context) do
return { statusCode: 200, body: 'Hello World' }
end
end
Configurer la clé d’API et le site Datadog
- Définissez la variable d’environnement
DD_SITE sur - 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.
Si vous n'utilisez pas l'un des outils de développement sans serveur pris en charge par Datadog, tels que Serverless Framework, Datadog vous recommande vivement d'instrumenter vos applications sans serveur avec l'
interface de ligne de commande Datadog.
Installer la bibliothèque Lambda Datadog
La bibliothèque Lambda Datadog peut être installée en tant que couche ou en tant que gem. Pour la plupart des fonctions, Datadog vous conseille d’installer la bibliothèque en tant que couche. Si votre fonction Lambda est déployée sous la forme d’une image de conteneur, vous devez installer la bibliothèque en tant que gem.
La version mineure du gem 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.
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>:20
# Use this format for AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-<RUNTIME>:20
Remplacez <AWS_REGION> par une région AWS valide, comme us-east-1. Les options disponibles pour RUNTIME disponibles sont Ruby2-7 et Ruby3-2.
Option B : si vous ne pouvez pas utiliser la couche Lambda Datadog prédéfinie, vous avez également la possibilité d’installer les gems datadog-lambda et ddtrace en les ajoutant à votre Gemfile :
gem 'datadog-lambda'
gem 'ddtrace'
ddtrace contient des extensions natives qui doivent être compilées pour Amazon Linux afin de fonctionner avec AWS Lambda. Datadog vous recommande donc de créer et déployer votre Lambda en tant qu’image de conteneur. Si votre fonction ne peut pas être déployée en tant qu’image de conteneur et que vous souhaitez utiliser la solution APM Datadog, il est conseillé d’installer la bibliothèque Lambda en tant que couche, et non en tant que gem.
Installez gcc, gmp-devel et make avant d’exécuter bundle install dans le Dockerfile de votre fonction, afin de vous assurer que les extensions natives peuvent être compilées.
FROM <base image>
# assemble your container image
RUN yum -y install gcc gmp-devel make
RUN bundle config set path 'vendor/bundle'
RUN bundle install
Installer l’extension Lambda Datadog
Option A : configurez les couches pour votre fonction Lambda à l’aide de l’ARN, en respectant le format ci-dessous :
# Use this format for x86-based Lambda deployed in AWS commercial regions
arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension:48
# Use this format for arm64-based Lambda deployed in AWS commercial regions
arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension-ARM:48
# Use this format for x86-based Lambda deployed in AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension:48
# Use this format for arm64-based Lambda deployed in AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension-ARM:48
Remplacez <AWS_REGION> par une région AWS valide, telle que us-east-1.
Option B : 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, 48) ou par latest. Accédez au référentiel Amazon ECR pour consulter la liste complète des tags disponibles.
Configurer vos fonctions Lambda
Activez la solution APM Datadog et incorporez la fonction Lambda de votre gestionnaire à l’aide du wrapper fourni par la bibliothèque Lambda Datadog.
require 'datadog/lambda'
Datadog::Lambda.configure_apm do |c|
# Enable the instrumentation
end
def handler(event:, context:)
Datadog::Lambda.wrap(event, context) do
return { statusCode: 200, body: 'Hello World' }
end
end
Configurer la clé d’API et le site Datadog
- Définissez la variable d’environnement
DD_SITE sur - 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.
Et ensuite ?
- Vous pouvez désormais visualiser des métriques, logs et traces sur la page d’accueil Serverless.
- Activez la surveillance des menaces pour recevoir des alertes en cas d’attaques ciblant votre service.
- Consultez l’exemple de code pour [surveiller une logique opérationnelle personnalisée](#surveiller-une-logique operationnelle-personnalisee).
- Consultez le guide de dépannage si vous ne parvenez pas à recueillir les données de télémétrie.
- Examinez les configurations avancées pour :
- Associer des données de télémétrie à l’aide de tags
- Recueillir des données de télémétrie pour AWS API Gateway, SQS, etc.
- Capturer les charges utiles des requêtes et des réponses Lambda
- Associer les erreurs de vos fonctions Lambda à votre code source
- Filtrer ou nettoyer des informations sensibles des logs ou des traces
Surveiller une logique opérationnelle personnalisée
Pour surveiller votre logique opérationnelle personnalisée, envoyez une métrique custom ou une span via l’exemple de code ci-dessous. Pour découvrir plus d’options, consultez la documentation relative à l’envoi de métriques custom pour des applications sans serveur ainsi que le guide APM pour l’instrumentation personnalisée.
require 'ddtrace'
require 'datadog/lambda'
Datadog::Lambda.configure_apm do |c|
# Activer l'instrumentation
end
def handler(event:, context:)
# Appliquer le wrapper Datadog
Datadog::Lambda::wrap(event, context) do
# Ajouter des tags personnalisés à la span de la fonction Lambda,
# cela ne fonctionne PAS lorsque le tracing X-Ray est activé
current_span = Datadog::Tracing.active_span
current_span.set_tag('customer.id', '123456')
some_operation()
Datadog::Tracing.trace('hello.world') do |span|
puts "Hello, World!"
end
# Envoyer une métrique custom
Datadog::Lambda.metric(
'coffee_house.order_value', # nom de la métrique
12.45, # valeur de la métrique
time: Time.now.utc, # facultatif, doit être dans les 20 dernières minutes
"product":"latte", # tag
"order":"online" # autre tag
)
end
end
# Instrumenter la function
def some_operation()
Datadog::Tracing.trace('some_operation') do |span|
# À vous de jouer
end
end
Pour en savoir plus sur l’envoi de métriques custom, consultez la section Métriques custom à partir d’applications sans serveur. Pour en savoir plus sur l’instrumentation personnalisée, consultez la documentation sur la solution APM Datadog relative à l’instrumentation personnalisée.
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles:
