Informations de référence sur les paramètres des journaux de diagnostic : Gestion des API
S’APPLIQUE À : Tous les niveaux de Gestion des API
Ces informations de référence décrivent les paramètres de journalisation des diagnostics d’API à partir d’une instance Gestion des API. Pour activer la journalisation des demandes d’API, consultez les instructions suivantes :
- Recueillir les journaux de ressources
- Intégrer la Gestion des API Azure avec Azure Application Insights
Notes
Certains paramètres, si indiqué, s’appliquent uniquement à la journalisation dans Application Insights.
| Paramètre | Type | Description |
|---|---|---|
| Activer | boolean | Indique si la journalisation de cette API est activée. La journalisation peut être activée pour toutes les API ou pour une API individuelle. Les paramètres d’une API individuelle remplacent les paramètres de toutes les API, s’ils sont activés. |
| Destination | Enregistreur d'événements Azure Application Insights | Spécifie l’enregistreur d’événements à utiliser pour la journalisation Application Insights. |
| Échantillonnage (%) | Décimal | Valeurs comprises entre 0 et 100 (%). Spécifie le pourcentage de demandes journalisées. Un échantillonnage à 0 % signifie qu’aucune demande ne sera consignée, tandis qu’un échantillonnage à 100 % indique qu’elles le seront toutes. Valeur par défaut : 100 Pour connaître l’impact sur les performances de la journalisation Application Insights, consultez Implications sur les performances et échantillonnage des journaux. |
| Toujours consigner les erreurs | boolean | Si ce paramètre est activé, tous les échecs sont journalisés, indépendamment du paramètre Échantillonnage. |
| Adresse IP du client du journal | boolean | Si ce paramètre est activé, l’adresse IP du client pour les demandes d’API est journalisée. |
| Commentaires | Spécifie la verbosité des journaux et indique si les traces personnalisées configurées dans les stratégies de trace sont journalisées. * Error : demandes ayant échoué et traces personnalisées avec la gravité error* Information : demandes ayant échoué ou réussi, et traces personnalisées avec la gravité error et information* Verbose : demandes ayant échoué ou réussi, et traces personnalisées avec la gravité error, information et verboseValeur par défaut : Information |
|
| Protocole de corrélation | Spécifie le protocole utilisé pour mettre en corrélation les données de télémétrie envoyées par plusieurs composants à Application Insights. Valeur par défaut : hérité Pour plus d’informations, consultez l’article Corrélation de télémétrie dans Application Insights. |
|
| En-têtes à journaliser | list | Spécifie les en-têtes journalisés pour les demandes et les réponses. Par défaut, aucun en-tête n’est consigné. |
| Nombre d’octets de charge utile (corps) à consigner | entier | Spécifie le nombre d’octets initiaux du corps de requête ou de réponse du serveur frontal ou du serveur principal qui sont enregistrés. Maximum 8,192. Valeur par défaut : 0 |
| Demande du serveur frontal | Spécifie si et comment les demandes de front-end (demandes entrantes sur la passerelle Gestion des API) sont journalisées. Si ce paramètre est activé, spécifiez En-têtes à journaliser, Nombre d’octets de charge utile à journaliser, ou les deux. |
|
| Réponse du serveur frontal | Spécifie si et comment les réponses de front-end (réponses sortantes de la passerelle Gestion des API) sont journalisées. Si ce paramètre est activé, spécifiez En-têtes à journaliser, Nombre d’octets de charge utile à journaliser, ou les deux. |
|
| Demande principale | Spécifie si et comment les demandes de back-end (demandes sortantes de la passerelle Gestion des API) sont journalisées. Si ce paramètre est activé, spécifiez En-têtes à journaliser, Nombre d’octets de charge utile à journaliser, ou les deux. |
|
| Réponse principale | Spécifie si et comment les réponses de back-end (réponses entrantes sur la passerelle Gestion des API) sont journalisées. Si ce paramètre est activé, spécifiez En-têtes à journaliser, Nombre d’octets de charge utile à journaliser, ou les deux. |
Important
Si cette option est activée, les charges utiles de requête ou de réponse enregistrées peuvent atteindre jusqu’à 8 192 octets. Gestion des API applique également une limite de 32 Ko pour une entrée de journal de diagnostic envoyée à Azure Monitor, qui inclut les charges utiles et d’autres attributs tels que les codes d’état, les en-têtes et les horodatages. Si la taille combinée des attributs dépasse 32 Ko, Gestion des API supprime l’entrée en supprimant tout le corps et le contenu de trace.
Étapes suivantes
- Pour plus d’informations, consultez les informations de référence sur l’entité Diagnostic dans l’API REST Gestion des API.
- Utilisez la stratégie de trace pour ajouter des traces personnalisées à la télémétrie Application Insights, aux journaux de ressource ou au suivi des demandes.