Compartir a través de

Referencia de configuración de registros de diagnóstico: API Management

  • Artículo

SE APLICA A: todos los niveles de API Management

Esta referencia describe la configuración del registro de diagnósticos de API desde una instancia de API Management. Para habilitar el registro de solicitudes de API, consulte las instrucciones siguientes:

Nota

Cierta configuración, cuando se indica, solo se aplica al registro en Application Insights.

Configuración Tipo Descripción
Habilitar boolean Especifica si el registro de esta API está habilitado.

El registro se puede habilitar para todas las API o para una API individual. La configuración de una API individual invalida la configuración de todas las API, si está habilitada.
Destination Registrador de Azure Application Insights Especifica el registrador que se va a usar para el registro de Application Insights.
Sampling (%) [Muestreo (%)] Decimal Valores de 0 a 100 (porcentaje).
Especifica el porcentaje de solicitudes registradas. Un muestreo del 0 % significa que no se registrará ninguna solicitud, mientras que un muestreo del 100 % se traduce en que se registrarán todas las solicitudes. Valor predeterminado: 100

Para ver los impactos en el rendimiento del registro de Application Insights, consulte Implicaciones de rendimiento y muestreo de registros.
Always log errors (Registrar errores siempre) boolean Si se selecciona esta opción, se registrarán todos los errores, independientemente del valor de muestreo.
Registro de la dirección IP del cliente boolean Si esta configuración está habilitada, se registra la dirección IP de cliente para las solicitudes de API.
Nivel de detalle Especifica el nivel de detalle de los registros y si se registran los seguimientos personalizados configurados en las directivas de seguimiento.

* Error: solicitudes con error y seguimientos personalizados de gravedad error
* Información: solicitudes con error y correctas, y seguimientos personalizados de gravedad error y information
* Verbose: solicitudes con error y correctas, y seguimientos personalizados de gravedad error, information y verbose

Valor predeterminado: información
Protocolo de correlación Especifica el protocolo utilizado para poner en correlación la telemetría enviada por varios componentes a Application Insights. Valor predeterminado: heredado

Para más información, consulte Correlación de Telemetría en Application Insights.
Encabezados para registrar list Especifica los encabezados que se registrarán para las solicitudes y las respuestas. Predeterminado: no se registra ningún encabezado.
Número de bytes de carga (cuerpo) para registrar integer Especifica el número de bytes iniciales del front-end o la solicitud de back-end o el cuerpo de respuesta que se registran. Máximo: 8,192. Valor predeterminado: 0
Solicitud de front-end Especifica si se registran solicitudes de front-end (solicitudes entrantes a la puerta de enlace de API Management), y cómo se registran.

Si esta opción está habilitada, especifique Encabezados para registrar, Número de bytes de carga que se van a registrar o ambos.
Respuesta de front-end Especifica si se registran respuestas de front-end (respuestas salientes de la puerta de enlace de API Management), y cómo se registran.

Si esta opción está habilitada, especifique Encabezados para registrar, Número de bytes de carga que se van a registrar o ambos.
Solicitud de back-end Especifica si se registran solicitudes de back-end (solicitudes salientes de la puerta de enlace de API Management), y cómo se registran.

Si esta opción está habilitada, especifique Encabezados para registrar, Número de bytes de carga que se van a registrar o ambos.
Respuesta de back-end Especifica si se registran respuestas de back-end (respuestas entrantes de la puerta de enlace de API Management), y cómo se registran.

Si esta opción está habilitada, especifique Encabezados para registrar, Número de bytes de carga que se van a registrar o ambos.

Importante

Si está habilitada, las cargas de solicitud o respuesta registradas pueden tener hasta 8 192 bytes. API Management también aplica un límite de 32 KB para una entrada de registro de diagnóstico enviada a Azure Monitor, que incluye las cargas y otros atributos, como códigos de estado, encabezados y marcas de tiempo. Si el tamaño combinado de los atributos supera los 32 KB, API Management recorta la entrada quitando todo el cuerpo y el contenido de seguimiento.

Pasos siguientes

  • Para obtener más información, consulte la referencia de la entidad de diagnóstico en la API de REST de API Management.
  • Use la directiva de seguimiento para agregar seguimientos personalizados a la telemetría, registros de recursos o seguimiento de solicitudes de Application Insights.