Información general

AWS Payload Extraction captura los datos de solicitudes y respuestas intercambiados entre tu aplicación y los servicios AWS. Esta función adjunta la información extraída como etiquetas (tags) a tus trazas (traces), lo que te permite ver los datos en dashboards y utilizarlos para generar alertas.

Requisitos

Se admiten los siguientes servicios AWS:

• Amazon Simple Notification Service (SNS)
• Amazon Simple Queue Service (SQS)
• Amazon Kinesis
• Amazon S3
• Amazon EventBridge

Se admiten las siguientes versiones de trazador y paquetes SDK de AWS:

Cómo funciona

AWS Payload Extraction extrae pares clave-valor de cuerpos jerárquicos de solicitudes y respuestas, convirtiéndolos en etiquetas separadas por puntos. Por ejemplo:

JSON de entrada:

{  
  "Message": {  
    "foo.bar": "baz",  
    "Arr": ["a", "b"]  
  }  
}

Etiquetas generadas:

aws.request.body.Message.foo\.bar: baz  
aws.request.body.Message.Arr.0: a  
aws.request.body.Message.Arr.1: b

Los rastreadores están configurados para coincidir con datos JSON anidados dentro de documentos JSON, que es un patrón común con las cargas útiles de SQS.

Configuración general

Activar AWS Payload Extraction

Para activar AWS Payload Extraction, configura estas variables de entorno:

# Analizar solicitudes
DD_TRACE_CLOUD_REQUEST_PAYLOAD_TAGGING=all

# Analizar respuestas  
DD_TRACE_CLOUD_RESPONSE_PAYLOAD_TAGGING=all

Puedes elegir analizar:

• Sólo cuerpos de solicitudes
• Sólo cuerpos de de respuestas
• Tanto cuerpos de solicitudes como de respuestas

El valor all indica que se utiliza todo el cuerpo para generar etiquetas. Para ver más opciones de configuración, consulta Proteger la información confidencial.

Proteger la información confidencial

Se espera que muchas de estas cargas útiles contengan información personal identificable (PII).

Para proteger la información confidencial, los rastreadores sustituyen los campos PII comunes por 'redacted' (como los números de teléfono en SNS). Nota: No puedes desactivar los datos ocultos por defecto.

Puedes especificar campos adicionales para ocultar utilizando la sintaxis JSONPath en las variables de entorno. Por ejemplo:

DD_TRACE_CLOUD_REQUEST_PAYLOAD_TAGGING=$.Metadata.UserId,$.Attributes.0.Pass

Este ejemplo:

• Oculta el campo UserId dentro del objeto Metadata
• Oculta el campo Pass en el primer elemento de la matriz Attributes
• Aplica el ocultamiento por defecto
• Sólo procesa cuerpos de solicitudes

Control de la profundidad de extracción de cargas útiles

Controla la profundidad máxima de extracción de cargas útiles con:

DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_DEPTH=10

El valor por defecto es 10. Los nodos que superan esta profundidad se ignoran durante la generación de etiquetas. La principal razón para modificar este valor es ajustar el rendimiento.

Desactivar AWS Payload Extraction

Configura estas variables como una cadena vacía u omitirlas desactiva la función:

DD_TRACE_CLOUD_REQUEST_PAYLOAD_TAGGING=""
DD_TRACE_CLOUD_RESPONSE_PAYLOAD_TAGGING=""

Configuración específica del lenguaje

Cada implementación del rastreador proporciona opciones adicionales de configuración específicas para ese lenguaje.

# Valores por defecto
DD_TRACE_CLOUD_PAYLOAD_TAGGING_SERVICES=s3,sns,sqs,kinesis,eventbridge

DD_TRACE_CLOUD_PAYLOAD_TAGGING_SERVICES=s3,sns,sqs,kinesis,eventbridge,amplify

# Valor por defecto
DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_TAGS=758

# Valores por defecto
DD_TRACE_CLOUD_PAYLOAD_TAGGING_SERVICES=ApiGateway,ApiGatewayV2,EventBridge,Sqs,Sns,S3,Kinesis

DD_TRACE_CLOUD_PAYLOAD_TAGGING_MAX_TAGS=758

Prácticas recomendadas

• Los diferentes rastreadores utilizan diferentes implementaciones de JSONPath, así que prueba tus consultas con cada rastreador individualmente.
• Comprueba siempre el comportamiento del ocultamiento en un entorno en staging antes de activarlo en producción.

Referencias adicionales

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

Más información sobre el rastreo de Datadog APMDOCUMENTACIÓN Terminología y descripción general de APMDOCUMENTACIÓN