Instrumentación de aplicaciones serverless de .NET

Si despliegas tus funciones de Lambda en una VPC sin acceso a la Internet pública, puedes enviar datos con AWS PrivateLink para el sitio de Datadog datadoghq.com, o bien mediante un proxy, en caso de que uses cualquier otro sitio.

Instalación

Datadog ofrece muchas formas diferentes de habilitar la instrumentación para tus aplicaciones serverless. Elige a continuación el método que mejor se adapte a tus necesidades. Por lo general, Datadog recomienda utilizar la Datadog CLI (interfaz de línea de comandos). Debes seguir las instrucciones para “Imagen de contenedor” si despliegas tu aplicación como una imagen de contenedor.

    La Datadog CLI modifica la configuración de las funciones de Lambda existentes para permitir la instrumentación sin tener que volver a desplegar. Es la forma más rápida de empezar a trabajar con la monitorización serverless de Datadog.

    1. Instalar el cliente de la Datadog CLI

      npm install -g @datadog/datadog-ci

    2. Si es la primera vez que usas la monitorización serverless de Datadog, inicia la Datadog CLI en el modo interactivo para recibir instrucciones sobre cómo realizar la primera instalación. Esto te permitirá entrar en materia rápidamente y saltarte los demás pasos. Si deseas instalar Datadog de forma permanente en tus aplicaciones de producción, omite ese paso y dirígete directamente a los siguientes para ejecutar el comando de la Datadog CLI en tus pipelines de CI/CD después de haber desplegado como lo haces normalmente.

      datadog-ci lambda instrument -i

    3. Configurar las credenciales de AWS

      La Datadog CLI necesita acceder al servicio AWS Lambda y depende del SDK de AWS para JavaScript a la hora de configurar las credenciales. Asegúrate de que tus credenciales de AWS estén configuradas con el mismo método que utilizarás para invocar la AWS CLI.

    4. Configurar el sitio de Datadog

      export DATADOG_SITE="<DATADOG_SITE>"

      Reemplaza <DATADOG_SITE> por (asegúrate de seleccionar el sitio [SITE] correcto del lado derecho).

    5. Configurar la clave de la API de Datadog

      Datadog recomienda guardar la clave de la API de Datadog en AWS Secrets Manager para una mayor seguridad y una rotación más sencilla. La clave debe almacenarse en una cadena de texto sin formato (no en un blob JSON). Asegúrate de que tus funciones de Lambda cuenten con el permiso de IAM obligatorio secretsmanager:GetSecretValue.

      export DATADOG_API_KEY_SECRET_ARN="<DATADOG_API_KEY_SECRET_ARN>"

      Si quieres hacer un testeo rápido, también puedes configurar la clave de la API de Datadog en texto sin formato:

      export DATADOG_API_KEY="<DATADOG_API_KEY>"

    6. Instrumentar las funciones de Lambda

      Nota: Antes que nada, instrumenta tus funciones de Lambda en un entorno de desarrollo o de prueba. Si el resultado de la instrumentación no es satisfactorio, ejecuta uninstrument con los mismos argumentos para revertir los cambios.

      Para instrumentar tus funciones de Lambda, ejecuta el siguiente comando.

      datadog-ci lambda instrument -f <functionname> -f <another_functionname> -r <aws_region> -v 16 -e 66

      Para rellenar los parámetros:

      • Reemplaza <functionname> y <another_functionname> por los nombres de tus funciones de Lambda. Otra posibilidad es usar --functions-regex para instrumentar automáticamente varias funciones cuyos nombres coincidan con la expresión regular facilitada.
      • Reemplaza <aws_region> por el nombre de la región de AWS.

      Si necesitas parámetros adicionales, consulta la documentación acerca de la CLI.

    El complemento Datadog Serverless Plugin configura automáticamente tus funciones para enviar métricas, trazas (traces) y logs a Datadog mediante la Datadog Lambda Extension.

    Para instalar y configurar el Datadog Serverless Plugin, sigue estos pasos:

    1. Instala el Datadog Serverless Plugin:

      serverless plugin install --name serverless-plugin-datadog

    2. Actualiza tu archivo serverless.yml:

      custom:
  datadog:
    site: <DATADOG_SITE>
    apiKeySecretArn: <DATADOG_API_KEY_SECRET_ARN>

      Para rellenar los parámetros:

      • Reemplaza <DATADOG_SITE> por (asegúrate de seleccionar el sitio [SITE] correcto del lado derecho).
      • Reemplaza <DATADOG_API_KEY_SECRET_ARN> por el ARN del secreto de AWS en el que almacenaste la clave de la API de Datadog de forma segura. La clave debe estar almacenada en una cadena de texto sin formato (no en un blob JSON). Además, el permiso secretsmanager:GetSecretValue es obligatorio. Si quieres hacer un testeo rápido, puedes usar apiKey en lugar del ARN y configurar la clave de la API de Datadog en texto sin formato.

      Para obtener más información y parámetros adicionales, consulta la documentación acerca del complemento.

    La macro de CloudFormation de Datadog transforma automáticamente tu plantilla de aplicación de SAM para instalar Datadog en tus funciones con las capas de Lambda. Además, configura las funciones para enviar métricas, trazas y logs a Datadog a través de la Datadog Lambda Extension.

    1. Instalar la macro de CloudFormation de Datadog

      Ejecuta el siguiente comando con tus credenciales de AWS para desplegar un stack tecnológico de CloudFormation que instale el recurso de AWS de la macro. Solo tienes que instalar la macro una vez en una región determinada de tu cuenta. Reemplaza create-stack por update-stack para actualizar la macro a la versión más reciente.

      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

      Con estos pasos, la macro ya está desplegada y lista para usar.

    2. Instrumentar las funciones de Lambda

      Añade la transformación DatadogServerless después de la transformación AWS::Serverless en la sección Transform de tu archivo template.yml para SAM.

      Transform:
  - AWS::Serverless-2016-10-31
  - Name: DatadogServerless
    Parameters:
      stackName: !Ref "AWS::StackName"
      dotnetLayerVersion: 16
      extensionLayerVersion: 66
      site: "<DATADOG_SITE>"
      apiKeySecretArn: "<DATADOG_API_KEY_SECRET_ARN>"

      Para rellenar los parámetros:

      • Reemplaza <DATADOG_SITE> por (asegúrate de seleccionar el sitio [SITE] correcto del lado derecho).
      • Reemplaza <DATADOG_API_KEY_SECRET_ARN> por el ARN del secreto de AWS en el que almacenaste la clave de la API de Datadog de forma segura. La clave debe estar almacenada en una cadena de texto sin formato (no en un blob JSON). Además, el permiso secretsmanager:GetSecretValue es obligatorio. Si quieres hacer un testeo rápido, puedes usar apiKey en lugar del ARN y configurar la clave de la API de Datadog en texto sin formato.

      Obtén más información y parámetros adicionales en la documentación de la macro.

    1. Instalar la Datadog Lambda Extension

      COPY --from=public.ecr.aws/datadog/lambda-extension:<TAG> /opt/. /opt/

      Reemplaza <TAG> por un número de versión específico (por ejemplo, 66) o por latest. Alpine también es compatible con números de versión específicos (como 66-alpine) o con latest-alpine. Puedes ver una lista completa de posibles etiquetas (tags) en el repositorio de Amazon ECR.

    2. Instalar el cliente de Datadog APM para .NET

      RUN yum -y install tar wget gzip
RUN wget https://github.com/DataDog/dd-trace-dotnet/releases/download/v<TRACER_VERSION>/datadog-dotnet-apm-<TRACER_VERSION>.tar.gz
RUN mkdir /opt/datadog
RUN tar -C /opt/datadog -xzf datadog-dotnet-apm-<TRACER_VERSION>.tar.gz
ENV AWS_LAMBDA_EXEC_WRAPPER /opt/datadog_wrapper

      Reemplaza <TRACER_VERSION> por el número de versión de dd-trace-dotnet que quieras usar (por ejemplo: 2.3.0). La versión compatible más antigua es 2.3.0. Puedes consultar las versiones más recientes de dd-trace-dotnet en GitHub.

    3. Configurar las variables de entorno obligatorias

      • Configura la variable de entorno DD_SITE como (asegúrate de seleccionar el sitio [SITE] correcto del lado derecho).
      • Configura la variable de entorno DD_API_KEY_SECRET_ARN con el ARN del secreto de AWS en el que almacenaste la clave de la API de Datadog de forma segura. La clave debe estar almacenada en una cadena de texto sin formato (no en un blob JSON). Además, el permiso secretsmanager:GetSecretValue es obligatorio. Si quieres hacer un testeo rápido, puedes usar DD_API_KEY en lugar del ARN y configurar la clave de la API de Datadog en texto sin formato.

    El módulo de Terraform lambda-datadog envuelve el recurso aws_lambda_function y configura automáticamente tu función de Lambda para Datadog Serverless Monitoring mediante las siguientes acciones:

    • adición de las capas de Lambda de Datadog,
    • redireccionamiento del controlador de Lambda,
    • habilitación de la recopilación y el envío de métricas, trazas y logs a Datadog.
    module "lambda-datadog" {
  source  = "DataDog/lambda-datadog/aws"
  version = "2.0.0"

  environment_variables = {
    "DD_API_KEY_SECRET_ARN" : "<DATADOG_API_KEY_SECRET_ARN>"
    "DD_ENV" : "<ENVIRONMENT>"
    "DD_SERVICE" : "<SERVICE_NAME>"
    "DD_SITE": "<DATADOG_SITE>"
    "DD_VERSION" : "<VERSION>"
  }

  datadog_extension_layer_version = 67
  datadog_dotnet_layer_version = 16

  # los argumentos de aws_lambda_function
}

    1. Reemplaza el recurso aws_lambda_function por el módulo de Terraform lambda-datadog y, luego, especifica el origen source y la versión version del módulo.

    2. Configura los argumentos de aws_lambda_function:

      Todos los argumentos disponibles en el recurso aws_lambda_function están disponibles en este módulo de Terraform. Los argumentos definidos como bloques en el recurso aws_lambda_function se redefinen como variables con sus argumentos anidados.

      Por ejemplo, en aws_lambda_function, environment se define como un bloque con un argumento variables. En el módulo de Terraform lambda-datadog, el valor de environment_variables se pasa al argumento environment.variables en aws_lambda_function. Consulta las entradas para ver una lista completa de las variables en este módulo.

    3. Rellena los parámetros de las variables de entorno:

      • Reemplaza <DATADOG_API_KEY_SECRET_ARN> por el ARN del secreto de AWS en el que almacenaste la clave de la API de Datadog de forma segura. La clave debe estar almacenada en una cadena de texto sin formato (no en un blob JSON). Además, el permiso secretsmanager:GetSecretValue es obligatorio. Si quieres hacer un testeo rápido, puedes usar la variable de entorno DD_API_KEY en lugar del ARN y configurar la clave de la API de Datadog en texto sin formato.
      • Reemplaza <ENVIRONMENT> por el entorno de la función de Lambda, como prod o staging.
      • Reemplaza <SERVICE_NAME> por el nombre del servicio de la función de Lambda.
      • Reemplaza <DATADOG_SITE> por . (Asegúrate de seleccionar el sitio de Datadog correcto en esta página).
      • Reemplaza <VERSION> por el número de versión de la función de Lambda.

    4. Selecciona las versiones de la capa de Lambda de la Datadog Extension y de la capa de Lambda de Datadog para .NET que quieres usar. Por defecto, se utilizan las últimas versiones de las capas.

      datadog_extension_layer_version = 67
  datadog_dotnet_layer_version = 16

    1. Instalar el rastreador de Datadog

      Configura las capas de tu función de Lambda con el ARN en el siguiente formato:

      # Use this format for x86-based Lambda deployed in AWS commercial regions
arn:aws:lambda:<AWS_REGION>:464622532012:layer:dd-trace-dotnet:16

# Use this format for arm64-based Lambda deployed in AWS commercial regions
arn:aws:lambda:<AWS_REGION>:464622532012:layer:dd-trace-dotnet-ARM:16

# Use this format for x86-based Lambda deployed in AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:dd-trace-dotnet:16

# Use this format for arm64-based Lambda deployed in AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:dd-trace-dotnet-ARM:16

      Reemplaza <AWS_REGION> por una región de AWS válida, como us-east-1.

    2. Instalar la Datadog Lambda Extension

      Configura las capas de tu función de Lambda con el ARN en el siguiente formato:

      # Use this format for x86-based Lambda deployed in AWS commercial regions
arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension:66

# Use this format for arm64-based Lambda deployed in AWS commercial regions
arn:aws:lambda:<AWS_REGION>:464622532012:layer:Datadog-Extension-ARM:66

# Use this format for x86-based Lambda deployed in AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension:66

# Use this format for arm64-based Lambda deployed in AWS GovCloud regions
arn:aws-us-gov:lambda:<AWS_REGION>:002406178527:layer:Datadog-Extension-ARM:66

      Reemplaza <AWS_REGION> por una región de AWS válida, como us-east-1.

    3. Configurar las variables de entorno obligatorias

      • Configura AWS_LAMBDA_EXEC_WRAPPER como /opt/datadog_wrapper.
      • Configura DD_SITE como (asegúrate de seleccionar el sitio [SITE] correcto del lado derecho).
      • Configura DD_API_KEY_SECRET_ARN con el ARN del secreto de AWS en el que almacenaste la clave de la API de Datadog de forma segura. La clave debe estar almacenada en una cadena de texto sin formato (no en un blob JSON). Además, el permiso secretsmanager:GetSecretValue es obligatorio. Si quieres hacer un testeo rápido, puedes usar DD_API_KEY en lugar del ARN y configurar la clave de la API de Datadog en texto sin formato.

    ¿Qué toca hacer ahora?

    Referencias adicionales

    Más enlaces, artículos y documentación útiles:

    Configurar Serverless MonitoringDOCUMENTACIÓN more more Solucionar problemas de Serverless MonitoringDOCUMENTACIÓN more more Envío de métricas personalizadas desde aplicaciones serverlessDOCUMENTACIÓN more more