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 seguimiento personalizado a la salida del seguimiento de solicitudes cuando se desencadena el seguimiento, es decir, cuando el encabezado de solicitud
Ocp-Apim-Trace
está presente y establecido entrue
y el encabezado de solicitudOcp-Apim-Subscription-Key
está presente y contiene una clave válida que permite el seguimiento. - 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.
Advertencia
- Solo permita el seguimiento en suscripciones destinadas a fines de depuración. Compartir claves de suscripciones con seguimiento permitido con usuarios no autorizados podría dar lugar a divulgación de información confidencial contenida en los registros de seguimiento, como claves, tokens de acceso, contraseñas, nombres de host internos y direcciones IP.
- En la consola de prueba, API Management deshabilita automáticamente el seguimiento 1 hora después de habilitarlo en una suscripción.
Nota:
Actualmente, el seguimiento de solicitudes de API no se admite en los niveles Básico v2 ni Estándar v2.
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ásico, v2, consumo y autohospedado
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 con Microsoft Copilot para Azure