Modifie les paramètres de la surveillance des applications, tels que l'échantillonnage des traces et les paramètres d'activation de l'agent.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| Pid |
string |
Oui |
L'identifiant de processus (PID) de l'application. Connectez-vous à la console ARMS. Dans le volet de navigation gauche, choisissez Surveillance des applications > Liste des applications. Sur la page Liste des applications, cliquez sur le nom d'une application. L'URL dans la barre d'adresse contient le PID de l'application. Le PID est indiqué au format pid=xxx. Le PID est généralement encodé en pourcentage sous la forme xxx%40xxx. Vous devez modifier cette valeur pour supprimer l'encodage en pourcentage. Par exemple, si le PID dans l'URL est xxx%4074xxx, vous devez remplacer %40 par un arobase (@) pour obtenir xxx@74xxx. |
a2n80plglh@745eddxxx |
| Settings |
array<object> |
Non |
Les paramètres de la surveillance des applications. |
|
|
object |
Non |
|||
| Key |
string |
Non |
La clé des paramètres que vous souhaitez modifier. Pour plus d'informations sur les paramètres pris en charge, consultez les sections suivantes.
|
sampling.enable |
| Value |
string |
Non |
La valeur des paramètres que vous souhaitez modifier. Pour plus d'informations sur les paramètres pris en charge, consultez les sections suivantes.
|
true |
Paramètres d'échantillonnage des traces
| Clé | Description | Valeur |
| sampling.enable | Indique s'il faut activer le commutateur d'échantillonnage. | Valeurs valides :- true : active le commutateur d'échantillonnage- false : désactive le commutateur d'échantillonnage |
| sampling.rate | Le taux d'échantillonnage. | Valeurs valides : 0 à 100. Valeur par défaut : 10. |
Paramètres d'activation de l'agent
| Clé | Description | Valeur |
| enable | Indique s'il faut activer le commutateur de l'agent. | Valeurs valides :- true : active le commutateur de l'agent- false : désactive le commutateur de l'agent |
Paramètres de seuil
| Clé | Description | Valeur |
| thresholds.limit | Le seuil de limitation. | Valeur par défaut : 100. |
| thresholds.interface | Le seuil de temps de réponse pour les appels d'API. | Valeur par défaut : 500. Unité : ms. |
| thresholds.sql | Le seuil de temps consommé par les requêtes SQL lentes. | Valeur par défaut : 500. Unité : ms. |
Paramètres avancés
| Clé | Description | Valeur |
| defined.excludeurl | Les appels d'API non valides que vous souhaitez exclure. | Séparez plusieurs appels d'API par des virgules (,).Valeur par défaut : /**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg.Exemple : /service/taobao,/service/status. |
| callstack.maxLength | La longueur maximale des piles de méthodes. | Valeur par défaut : 128. Valeur maximale : 400. |
| exception.stacktrace | La profondeur de pile sur laquelle le système s'appuie pour identifier le même type d'exceptions. | Valeur par défaut : 2. Le système identifie le même type d'exceptions en fonction de la profondeur de pile spécifiée. Si vous modifiez la valeur, des statistiques inattendues peuvent se produire. Procédez avec prudence. |
| callsql.maxLength | La longueur maximale des instructions SQL collectées. | Une instruction SQL collectée doit comporter entre 256 et 4096 caractères. Valeur par défaut : 1024. |
| jdbc.tracesqlbindvalue | Indique s'il faut capturer les variables liées au paramètre PrepareStatement. | Valeurs valides :-true : active la capture des variables liées au paramètre PrepareStatement- false : désactive la capture des variables liées au paramètre PrepareStatement |
| jdbc.tracesqlraw | Indique s'il faut capturer les instructions SQL brutes. | Valeurs valides :- true : active la capture des instructions SQL brutes- false : désactive la capture des instructions SQL brutes |
| exception.whitelist | Les exceptions que vous souhaitez exclure. | La valeur doit être une expression régulière qui spécifie le nom d'une catégorie d'exceptions. Séparez plusieurs catégories d'exceptions par des virgules (,). Exemple : java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException. Les exceptions des catégories que vous spécifiez ne sont pas affichées dans les graphiques des pages Détails de l'application et Diagnostic des exceptions. |
| error.skip | Les erreurs que vous souhaitez exclure. | Par défaut, tous les codes d'état HTTP supérieurs à 400 sont comptabilisés comme des erreurs. Pour ignorer des codes d'état HTTP spécifiques supérieurs à 400, vous pouvez les spécifier comme valeur de cette clé. Ainsi, ils ne seront pas comptabilisés comme des erreurs. Séparez plusieurs codes d'état HTTP par des virgules (,). Exemples : 429 et 429,512. Cette clé est prise en charge par la version 2.5.7.2 ou ultérieure de l'agent. |
| compress.enable | Indique s'il faut activer le commutateur de compression des traces. | Valeurs valides :- true : active le commutateur de compression des traces- false : désactive le commutateur de compression des traces |
| param.maxLength | La longueur maximale des paramètres de requête. | Valeur par défaut : 512. Si la valeur est supérieure à la valeur par défaut, des ressources système supplémentaires sont consommées. Faites preuve de prudence lors de la configuration de cette clé. |
| quantile.enable | Indique s'il faut activer le commutateur de statistiques de quantile. | Valeurs valides :- true : active le commutateur de statistiques de quantile- false : désactive le commutateur de statistiques de quantile |
| threadpoolmonitor.enable | Indique s'il faut activer la surveillance du pool de threads et du pool de connexions. | La configuration de cette clé prend effet après le redémarrage de l'application.Valeurs valides :- true : active la surveillance du pool de threads et du pool de connexions- false : désactive la surveillance du pool de threads et du pool de connexions |
| async.autoTransmit | Indique s'il faut activer le commutateur de propagation asynchrone automatique. | Cette clé n'est valide que lorsque la version de l'agent est 2.8.3 ou ultérieure.La configuration de cette clé prend effet après le redémarrage de l'application. Cette fonctionnalité encapsule les tâches Runnable et Callable soumises au pool de threads pour propager le contexte. Des risques potentiels peuvent survenir. Faites preuve de prudence lors de la configuration de cette clé.Valeurs valides :-true : active le commutateur de propagation asynchrone automatique- false : désactive le commutateur de propagation asynchrone automatique |
| thread.match.package | Le nom du package pour la propagation asynchrone. | Cette clé n'est valide que lorsque la version de l'agent est 2.7.1.3 ou ultérieure.La configuration de cette clé prend effet après le redémarrage de l'application. Lorsqu'un Runnable, Callable ou Supplier sous le package spécifié est créé, le contexte de trace est automatiquement capturé et propagé au nouveau thread. Séparez plusieurs noms de packages par des virgules (,). |
| responseInject.enable | Indique s'il faut activer le commutateur de renvoi de l'identifiant de trace dans la requête. | Valeurs valides :- true : active le commutateur- false : désactive le commutateur |
Paramètres de thread
| Clé | Description | Valeur |
| tprof.enableThreadProfiler | Indique s'il faut activer le commutateur principal du profilage de threads. | Valeurs valides :- true : active le commutateur- false : désactive le commutateurSi vous activez ce commutateur, les piles de méthodes natives des appels d'API lents sont automatiquement enregistrées. |
| tprof.threadProfilerSlowInteractionRt | Le seuil de temps consommé par les appels d'API lents. | Valeur par défaut : 2000. Si le temps consommé par les appels d'API lents dépasse le seuil, le profilage de threads est activé. Nous vous recommandons de définir la valeur sur le 99e centile du temps consommé. Si vous définissez une valeur inférieure à 2000, la consommation de processeur augmente. Nous vous recommandons de définir une valeur supérieure ou égale à 500. |
| tprof.enableThreadStackRecorder | Indique s'il faut activer le profilage de threads pour les piles de méthodes. | Valeurs valides :- true : active le profilage de threads pour les piles de méthodes- false : désactive le profilage de threads pour les piles de méthodesSi vous activez le profilage de threads, les piles de méthodes sont collectées toutes les 5 minutes. |
Paramètres d'association des journaux d'activité
| Clé | Description | Valeur |
| logging.enable | Indique s'il faut activer le commutateur pour associer les identifiants de trace aux journaux d'activité. | Valeurs valides :- true : active le commutateur- false : désactive le commutateurSi vous activez ce commutateur, les identifiants de trace sont automatiquement générés dans les journaux d'activité d'une application. Ce paramètre prend effet après le redémarrage de l'application. Les utilitaires de journalisation tels que Log4j, Log4j2 et Logback sont pris en charge. Vous devez ajouter %X{EagleEye-TraceID} à la mise en page du journal pour générer des identifiants de trace. |
| SLS.project | Le projet Simple Log Service qui stocke les journaux d'activité générés dans la région actuelle. | Vous pouvez spécifier le nom d'un projet Simple Log Service qui stocke les journaux d'activité générés dans la région actuelle. |
| SLS.logStore | Le Logstore Simple Log Service qui stocke les journaux d'activité générés dans la région actuelle. | Vous pouvez spécifier le nom d'un Logstore Simple Log Service qui stocke les journaux d'activité générés dans la région actuelle. |
| SLS.index | Le type d'index des journaux d'activité générés dans la région actuelle. | Valeurs valides :- Si vous souhaitez utiliser des index en texte intégral, ne définissez pas cette clé.- Si vous souhaitez utiliser un index spécifique à un champ, définissez la valeur sur le nom du champ. Exemple : SLS.index: tag.Pour plus d'informations sur les différences entre les index spécifiques à un champ et les index en texte intégral, consultez Configurer des index. |
Paramètres de convergence d'URL
| Clé | Description | Valeur |
| convergence.enable | Indique s'il faut activer la fonctionnalité de convergence d'URL. | Valeurs valides :- true : active la fonctionnalité de convergence d'URL- false : désactive la fonctionnalité de convergence d'URL |
| convergence.minServerSize | Le seuil de convergence. | Si le seuil est dépassé, la convergence est effectuée. |
| convergence.pattern | L'expression régulière des règles de convergence. | Vous pouvez utiliser des expressions régulières pour configurer des règles de convergence. Séparez plusieurs expressions régulières par des virgules (,). Saisissez une URL dans le texte d'origine pour indiquer que l'URL n'est pas convergée. Exemple : /service/(.*?)/demo. |
Paramètres de diagnostic Arthas
Remarque : Les paramètres de diagnostic Arthas ne prennent effet que lorsque la version de l'agent est 2.7.1.3 ou ultérieure. Pour plus d'informations sur les autres prérequis, consultez Diagnostic Arthas.
| Clé | Description | Valeur |
| arthas.enable | Indique s'il faut activer le commutateur Arthas. | Valeurs valides :- true : active le commutateur Arthas- false : désactive le commutateur Arthas |
| arthas.enableIps | Les adresses IP pour lesquelles la fonctionnalité de diagnostic Arthas est activée. | Si vous configurez cette clé, la fonctionnalité de diagnostic Arthas ne prend effet que sur les adresses IP spécifiées. Si vous ne configurez pas cette clé, la fonctionnalité de diagnostic Arthas prend effet sur toutes les adresses IP par défaut. Séparez plusieurs adresses IP par des virgules (,). |
Paramètres de profilage continu
Remarque : Les paramètres de profilage continu ne prennent effet que lorsque la version de l'agent est 2.7.3.5 ou ultérieure. Pour plus d'informations sur les autres prérequis, consultez Profilage continu.
| Clé | Description | Valeur |
| cp.enable | Indique s'il faut activer le commutateur de profilage continu. | Valeurs valides :- true : active le commutateur de profilage continu- false : désactive le commutateur de profilage continu* Si vous activez ce commutateur, vous devez configurer les adresses IP sur lesquelles le commutateur prend effet. Sinon, le commutateur ne prend pas effet. Vous pouvez configurer les adresses IP selon les deux modes suivants. |
|||| |---|---|---|---| |Mode|Clé|Description|Valeur| |Liste blanche d'adresses IP|cp.allowIPs|Liste blanche d'adresses IP|Les adresses IP des instances pour lesquelles le profilage continu est activé. Séparez plusieurs adresses IP par des virgules (,).Exemple : 192.168.0.1,192.168.0.2| |cp.allowNetwork|Bloc CIDR|Spécifiez une chaîne vide. Sinon, le profilage continu ne fonctionne pas correctement.| |Bloc CIDR|cp.allowIPs|Liste blanche d'adresses IP|Spécifiez une chaîne vide. Sinon, le profilage continu ne fonctionne pas correctement.| |cp.allowNetwork|Bloc CIDR|Le bloc CIDR des instances pour lesquelles le profilage continu est activé.Exemple : 192.168.2.0/24/24|
Paramètres de masquage des données Remarque : Les paramètres de masquage des données ne prennent effet que lorsque la version de l'agent est 2.9.0 ou ultérieure.
| Clé | Description | Valeur |
| sanitizer.enable | Indique s'il faut activer le commutateur de masquage des données. | Valeurs valides :- true : active le commutateur de masquage des données- false : désactive le commutateur de masquage des données |
| sanitizer.keys | Les règles de masquage des données. | Vous pouvez spécifier des règles pour le masquage des données, comme indiqué dans l'exemple. Les règles spécifiées sont utilisées comme clés pour une correspondance exacte. Par exemple, si vous spécifiez password, la règle équivaut à l'expression régulière .*password.*. Les clés ne sont pas sensibles à la casse. Séparez plusieurs règles par des virgules (,).Exemple : password, secret, key, token et credentials |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
|||
| Data |
string |
Indique si l'appel a réussi. |
success |
| RequestId |
string |
L'identifiant de la requête. |
78901766-3806-4E96-8E47-CFEF59E4**** |
| Message |
string |
Le message renvoyé. |
message |
| Code |
integer |
Le code d'état HTTP. 2XX indique que la requête a réussi. 3XX indique que la requête a été redirigée. 4XX indique qu'une erreur de requête s'est produite. 5XX indique qu'une erreur de serveur s'est produite. |
200 |
| Success |
boolean |
Indique si la requête a réussi. Valeurs valides :
|
true |
Exemples
JSON format
{
"Data": "success",
"RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
"Message": "message",
"Code": 200,
"Success": true
}
Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
Description |
|---|---|---|---|
| 400 | ParameterMissing | You must specify the parameter. | You must specify the parameter. |
| 400 | ParameterTraceAppSettingKeyIllegal | The application configuration key is invalid. | The application configuration key is invalid. |
| 400 | ParameterTraceAppSettingValueIllegal | The application configuration value is invalid. | The application configuration value is invalid. |
| 400 | InternalError | InterPlease try again. Contact the DingTalk service account if the issue persists after multiple retries. | |
| 404 | AppNotExist | The application does not exist. | The application does not exist. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.