Datadog recomienda la macro serverless CloudFormation para los clientes que utilizan AWS SAM para desplegar sus aplicaciones serverless.

La macro configura automáticamente la ingesta de métricas, trazas (traces) y logs desde tus aplicaciones serverless mediante:

• Instalación y configuración de la biblioteca Datadog Lambda biblioteca y la extensión Lambda para tus funciones de Python, Node.js, .NET y Java Lambda.
• Habilitación de la recopilación métricas mejoradas de Lambda y métricas personalizadas de tus funciones Lambda.
• Administración de suscripciones desde Datadog Forwarder a tus grupos de logs de funciones Lambda, si lo deseas.

Instalación

Para que la macro Datadog serverless esté disponible para utilizarla en tu cuenta de AWS, despliega un stack de CloudFormation con una plantilla proporcionada por Datadog. Esta implementación incluye un recurso de macro de CloudFormation y una función Lambda que se invoca cuando se ejecuta la macro. El despliegue de este stack te permite utilizar la macro en otros stacks de CloudFormation desplegados en la misma cuenta. Para obtener más detalles sobre la definición de una macro en tu cuenta, consulta la página de documentación de CloudFormation.

Nota: La macro Datadog serverless debe crearse una vez en cada región que contenga stacks que desees transformar.

Opción 1: AWS Console

Crea el stack de macros Datadog serverless en tu cuenta de AWS utilizando el enlace a la plantilla Launch Stack anterior.

Opción 2: AWS CLI

Si estás instalando por primera vez, despliega con:

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

Utilización con AWS SAM

Para desplegar tu aplicación serverless con SAM, añade la macro CloudFormation Datadog serverless en la sección Transform en tu archivo template.yml, después de la transformación SAM requerida. Añade también un parámetro de DDGitData y pásalo a la macro para habilitar integración con el código fuente de Datadog:

Transformar:
  - AWS::Serverless-2016-10-31
  - Nombre: DatadogServerless
    Parámetros:
      stackName: !Ref "AWS::StackName"
      apiKey: "<DATADOG_API_KEY>"
      pythonLayerVersion: "<LAYER_VERSION>" # Utiliza el parámetro apropiado para otros tiempos de ejecución
      extensionLayerVersion: "<LAYER_VERSION>"
      servicio: "<SERVICE>" # Opcional
      variable de entorno: "<ENV>" # Opcional
      versión: "<VERSION>" # Opcional
      etiquetas (tags): "<TAGS>" # Opcional
      # Pasa DDGitData aquí para habilitar el etiquetado de la integración del código fuente
      gitData: !Ref DDGitData
      # Para obtener parámetros adicionales, consulta la sección de configuración

Parámetros:
  DDGitData:
    Tipo: Cadena
    Por defecto: ""
    Description: "The output of $(git rev-parse HEAD),$(git config --get remote.origin.url). Used for Datadog Source Code Integration tagging"

Para configurar el parámetro DDGitData para la integración del código fuente de Datadog, utiliza la opción --parameter-overrides de SAM:

sam deploy --parameter-overrides  DDGitData="$(git rev-parse HEAD),$(git config --get remote.origin.url)"

Nota: Si no modificaste el archivo template.yml proporcionado cuando instalaste la macro, el nombre de la macro definida en tu cuenta será DatadogServerless. Si has modificado la plantilla original, asegúrate de que el nombre de la transformación que añadas aquí coincida con la propiedad Name del recurso AWS::CloudFormation::Macro.

Nota: Si deseas especificar algo de las configuración solo una vez, puedes modificar template.yml y añadir las variables de entorno que desees configurar para esa región. Esta es una forma de controlar los valores por defecto adicionales. El ejemplo siguiente configura DD_API_KEY_SECRET_ARN y DD_ENV, que la macro tratará como valores por defecto:

Recursos:
  MacroFunction:
    Tipo: AWS::Serverless::Function
    DependsOn: MacroFunctionZip
    Propiedades:
      FunctionName:
        Fn::If:
          - SetFunctionName
          - Ref: FunctionName
          - Ref: AWS::NoValue
      Descripción: Procesos de una plantilla de CloudFormation para instalar Datadog Lambda layers para funciones Lambda.
      Controlador: src/index.handler
      ...
      Entorno:
        Variables:
          DD_API_KEY_SECRET_ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:DdApiKeySecret-e1v5Yn7TvIPc-d1Qc4E"
          DD_ENV: "dev"

Actualización

Si vas a actualizar la macro después de una nueva versión, utiliza el método update-stack:

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

También puedes especificar una versión de la macro de las últimas versiones sustituyendo latest.yml con la versión, por ejemplo 0.1.2.yml.

Configuración

Para configurar más tu complemento, utiliza los siguientes parámetros personalizados:

Cómo funciona

Esta macro modifica tu plantilla de CloudFormation para instalar la biblioteca Datadog Lambda adjuntando las Lambda Layers para Node.js, Python, .NET y Java a tus funciones. Redirige a un controlador de sustitución que inicializa la biblioteca Lambda sin ningún cambio de código requerido.

Solucionar problemas

Depurar logs

Para ayudarte a depurar problemas, puedes consultar en los logs de CloudWatch la función Lambda de la macro. Para encontrar los logs de CloudWatch:

• Encuentra el stack CloudFormation de la macro (llamada datadog-serverless-macro si has copiado el comando en las instrucciones)
• Haz clic en la pestaña de recursos y el grupo de logs de CloudWatch debería estar disponible con el ID lógico MacroFunctionLogGroup

Mensaje de error: La propiedad ‘FunctionName’ no está definida para…

Este error se produce cuando proporcionas un forwarderArn y estás desplegando tu función Lambda por primera vez, por lo que no existe actualmente ningún grupo de logs y la macro no puede crear este grupo de logs ni suscribirse al Forwarder por ti. Una forma de solucionar este problema es definir explícitamente la propiedad FunctionName en tu Lambda (consulta el ejemplo siguiente).

Recursos:
  MyLambda:
    Tipo: AWS::Serverless::Function
    Propiedades:
      Controlador: index.handler
      Tiempo de ejecución: nodejs12.x
      FunctionName: MyFunctionName # Añade esta propiedad a tus Lambdas

Si no puedes (o prefieres no) definir el FunctionName explícitamente, elimina el parámetro forwarderArn de la plantilla SAM o del código fuente CDK y, en su lugar, define los filtros de suscripción utilizando el recurso AWS::Logs::SubscriptionFilter como se indica a continuación.

Recursos:
  MyLogSubscriptionFilter:
    Tipo: "AWS::Logs::SubscriptionFilter"
    Propiedades:
      DestinationArn: "<DATADOG_FORWARDER_ARN>"
      LogGroupName: "<CLOUDWATCH_LOG_GROUP_NAME>"
      FilterPattern: ""

Mensaje de error: ’logGroupNamePrefix’ no satisface la restricción…

La opción forwarderArn no funciona cuando FunctionName contiene funciones de CloudFormation, como !Sub. En este caso, la macro no tiene acceso al nombre de la función real (CloudFormation ejecuta funciones después de las transformaciones). Por lo tanto, no puede crear grupos de logs ni filtros de suscripción para tus funciones.

Elimina el parámetro forwarderArn de la plantilla SAM o del código fuente CDK y, en su lugar, define los filtros de suscripción utilizando el recurso AWS::Logs::SubscriptionFilter como se indica a continuación.

Recursos:
  MyLogSubscriptionFilter:
    Tipo: "AWS::Logs::SubscriptionFilter"
    Propiedades:
      DestinationArn: "<DATADOG_FORWARDER_ARN>"
      LogGroupName: "<CLOUDWATCH_LOG_GROUP_NAME>"
      FilterPattern: ""

Mensaje de error: ‘Error al ejecutar la transformación DatadogServerless’

Este error puede producirse si el usuario IAM que ejecuta el comando no tiene el permiso lambda:InvokeFunction. Añade el permiso al rol IAM del usuario.

Comunidad

Si tienes preguntas o comentarios sobre el producto, únete al canal #serverless en la comunidad Datadog en Slack.