Seguimiento
SE APLICA A: todos los niveles de API Management
La directiva trace
agrega un seguimiento personalizado a la salida del seguimiento de solicitudes en la consola de prueba, a los datos de telemetría de Application Insights o a los registros de recursos.
- La directiva agrega un rastreo personalizado a la salida de rastreo de solicitudes en la consola de pruebas cuando se activa el rastreo.
- La directiva crea telemetría de seguimiento en Application Insights cuando está habilitada la integración de Application Insights y el nivel de
severity
especificado en la directiva es mayor o igual que el nivel deverbosity
especificado en la configuración de diagnóstico. - La directiva agrega una propiedad en la entrada del registro cuando se habilitan registros de recursos y el nivel de gravedad especificado en la directiva es igual o mayor que el nivel de detalle especificado en la configuración de diagnóstico.
- La directiva no se ve afectada por el muestreo de Application Insights. Todas las invocaciones de la directiva se registrarán.
Importante
- API Management ya no admite suscripciones para el seguimiento o el encabezado Ocp-Apim-Trace.
- Para mejorar la seguridad de las API, ahora se puede habilitar el seguimiento en el nivel de una API individual al obtener un token de tiempo limitado mediante la API de REST de API Management y pasar el token en una solicitud a la puerta de enlace. Para más información, vea Habilitación del seguimiento de una API.
- Tenga cuidado al habilitar el seguimiento, ya que puede exponer información confidencial en los datos de seguimiento. Asegúrese de que tiene las medidas de seguridad adecuadas para proteger los datos de seguimiento.
Nota:
Establezca los elementos de la directiva y los elementos secundarios en el orden proporcionado en la instrucción de directiva. Obtenga más información sobre el establecimiento o modificación de directivas de API Management.
Instrucción de la directiva
<trace source="arbitrary string literal" severity="verbose | information | error">
<message>String literal or expressions</message>
<metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>
Atributos
Atributo | Descripción | Necesario | Valor predeterminado |
---|---|---|---|
source | Literal de cadena que resulta significativo para el visor de seguimiento y especifica el origen del mensaje. No se permiten expresiones de directiva. | Sí | N/D |
severity | Especifica el nivel de gravedad del seguimiento. Los valores permitidos son verbose , information y error (de menor a mayor). No se permiten expresiones de directiva. |
No | verbose |
Elementos
Nombre | Descripción | Obligatorio |
---|---|---|
message | Cadena o expresión que se va a registrar. Se permiten expresiones de directiva. | Sí |
metadata | Agrega una propiedad personalizada a la telemetría Trace de Application Insights. | No |
Atributos de metadatos
Atributo | Descripción | Necesario | Valor predeterminado |
---|---|---|---|
name | Nombre de la propiedad. | Sí | N/D |
value | Valor de la propiedad. | Sí | N/D |
Uso
- Secciones de la directiva: entrante, saliente y back-end
- Ámbitos de la directiva: global, área de trabajo, producto, API, operación
- Puertas de enlace: clásica, v2, consumo, autohospedada y área de trabajo
Ejemplo
<trace source="PetStore API" severity="verbose">
<message>@((string)context.Variables["clientConnectionID"])</message>
<metadata name="Operation Name" value="New-Order"/>
</trace>
Directivas relacionadas
Contenido relacionado
Para más información sobre el trabajo con directivas, vea:
- Tutorial: Transformación y protección de una API
- Referencia de directivas para una lista completa de instrucciones de directivas y su configuración
- Expresiones de directiva
- Establecimiento o edición de directivas
- Reutilización de configuraciones de directivas
- Repositorio de fragmentos de código de directiva
- Creación de directivas mediante Microsoft Copilot en Azure