Application Real-Time Monitoring Service:Configuration personnalisée pour les applications Go

Prérequis

Une sonde doit être installée pour votre application. Pour plus d'informations, consultez Application Monitoring Integration Overview.

Procédure

1. Connectez-vous à la console ARMS. Dans le volet de navigation de gauche, choisissez Application Monitoring > Application List.

2. Sur la page Application List, sélectionnez la région dans la barre de navigation supérieure, puis cliquez sur le nom de l'application.

   Remarque

   Les icônes de la colonne Language ont les significations suivantes :

   • : une application Java connectée à Application Monitoring.

   • : une application Golang connectée à Application Monitoring.

   • : une application Python connectée à Application Monitoring.

   • - : une application connectée à Managed Service for OpenTelemetry.

3. Dans la barre de navigation supérieure, choisissez Application Configuration > Custom Configurations.

4. Configurez les paramètres, puis cliquez sur Save.

Paramètres d'échantillonnage

Dans la section Sampling settings, définissez la politique d'échantillonnage pour les traces. Les applications Go ne prennent actuellement en charge que l'échantillonnage à taux fixe. Vous pouvez également configurer un échantillonnage complet basé sur le nom de l'API, le préfixe ou le suffixe.

La valeur par défaut de Sampling rate percentage est 10. L'augmentation du taux d'échantillonnage consomme des ressources système supplémentaires ; il est donc recommandé de conserver la valeur par défaut. La fonctionnalité Full sampling by API name n'est prise en charge que par les versions de sonde 1.5.2 et ultérieures. Une fois la configuration terminée, cliquez sur Save ou sur Save and Bulk Copy to Other Applications.

Bascules de la sonde

Dans la section Probe toggle settings, activez ou désactivez Application Monitoring et les plugins individuels.

Lorsque vous activez la bascule Pause application monitoring, la facturation est également suspendue. La section Plugin toggles comprend plusieurs plugins tels que dubbo-plugin, mysql-plugin, redis-plugin, grpc-plugin et kafka-client-plugin. Pour hertz-plugin, opentelemetry-plugin et opentracing-plugin, les modifications ne prennent effet qu'après le redémarrage de l'application. Après avoir effectué les modifications, cliquez sur Save ou sur Bulk Copy to Other Applications pour synchroniser la configuration avec d'autres applications.

Bascules d'exécution

Dans la section Runtime toggle settings, activez ou désactivez la fonctionnalité de surveillance Runtime. Pour plus d'informations, consultez Runtime monitoring.

Après avoir configuré les paramètres, cliquez sur Save ou sur Save and Bulk Copy to Other Applications pour appliquer la configuration à d'autres applications.

Association des journaux d'application

Dans la section Application log association, configurez la source des journaux pour votre application afin d'injecter le SpanId et le TraceId dans les journaux correspondants. Pour plus d'informations, consultez Associate TraceId with business logs of Go applications.

Activez la bascule Automatically associate business logs with TraceId, puis dans la section Log Service binding, sélectionnez une région, un nom de projet, un type d'association (Logstore ou StoreView), un nom de Logstore et un index associé. Ensuite, cliquez sur Save. Pour appliquer la configuration à d'autres applications, cliquez sur Bulk Copy to Other Applications.

Convergence d'URL

Dans la section URL convergence settings, activez ou désactivez la fonctionnalité de convergence d'URL et configurez son seuil et ses règles. La convergence d'URL regroupe les URL similaires et les affiche sous forme d'un seul élément. Par exemple, une série d'URL commençant par /service/demo/ peut être affichée comme une seule entrée agrégée. Le seuil de convergence représente le nombre minimal d'URL devant correspondre à une règle avant qu'elles ne soient convergées. Par exemple, si le seuil est de 100, les URL correspondant à l'expression régulière d'une règle ne sont convergées qu'une fois que le nombre d'URL correspondantes atteint 100. Pour plus d'informations, consultez ARMS convergence mechanism.

Les règles de convergence doivent être au format d'expression régulière. Exemple : /service/(.*?)/demo. Séparez plusieurs règles par une virgule (,). Après avoir configuré les paramètres, cliquez sur Save ou sur Save and Bulk Copy to Other Applications.

Profilage continu

Dans la section Continuous profiling settings, activez ou désactivez la bascule globale, les points chauds CPU, les points chauds mémoire et les points chauds de code. Pour plus d'informations, consultez Continuous profiling for Go applications.

Vous pouvez également activer ou désactiver les goroutine hotspots (nécessite la version 1.6.0 de la sonde ou ultérieure), l'analyse des blocages et l'analyse des mutex (nécessite la version 1.6.1 de la sonde ou ultérieure). Après avoir configuré les paramètres, cliquez sur Save ou sur Bulk Copy to Other Applications.

Configuration des appels API

Dans la section API call configuration, configurez le seuil d'appel lent, la liste d'autorisation des codes d'état HTTP et le filtrage des appels API invalides.

Vous pouvez également configurer les paramètres suivants : les bascules Enable printing HTTP request body et Enable printing HTTP request header (nécessitent la version 1.5.0 de la sonde ou ultérieure), HTTP request body length (par défaut 1024, nécessite la version 1.4.0 de la sonde ou ultérieure), la bascule Include TraceId in HTTP response (ajoute la clé Eagleeye-TraceId à l'en-tête de réponse), les bascules Enable printing HTTP response body et Enable printing HTTP response header (nécessitent la version 1.5.1 de la sonde ou ultérieure), HTTP response body length (par défaut 1024) et les champs de texte Write HTTP request header keys to Span et Write HTTP response header keys to Span.

• Slow call threshold : la valeur par défaut est 500 ms. Un appel d'interface est marqué comme lent si son temps de réponse dépasse ce seuil.

• HTTP status code whitelist :

  Par défaut, les codes d'état HTTP supérieurs à 400 sont classés comme des erreurs. Pour empêcher certains codes d'état d'être classés comme des erreurs, ajoutez-les à la liste d'autorisation.

  Ce paramètre affecte uniquement les frameworks HTTP pris en charge par Application Monitoring.

  Données affectées : métriques de comptage des erreurs pour les serveurs et clients HTTP (arms_http_requests_error_count, arms_http_client_requests_error_count et arms_app_requests_error_count), ainsi que le statut Span.

  Fonctionnalités affectées : comptes d'erreurs dans les onglets Application Overview, Provided Services et Dependent Services. Statut Span et alertes de comptage des erreurs sur la page Trace Analysis.

  Format : saisissez les codes d'état individuels séparés par des virgules (,). La correspondance floue n'est pas prise en charge.

  Exemple : 403,502

  Par défaut : vide

• Invalid API call filtering :

  Pour masquer certains appels dans l'onglet Provided Services, saisissez les noms d'API à exclure. La sonde cesse alors de rapporter les données d'observation pour ces API, ce qui les masque de la page des appels API.

  Données affectées : toutes les métriques et Spans pour les API spécifiées sont ignorées.

  Fonctionnalités affectées : toutes les métriques pour les API correspondantes dans les onglets Application Overview, Provided Services et Dependent Services. Alertes de comptage de Spans, de volume d'appels, de comptage d'erreurs et d'appels lents sur la page Trace Analysis.

  Format : utilisez une chaîne ou une expression AntPath pour faire correspondre le nom complet de l'API. Séparez plusieurs règles par des virgules (,). (Les expressions AntPath par défaut sont incluses pour la rétrocompatibilité avec les données historiques. Ne les supprimez pas. Ajoutez de nouvelles règles après celles existantes.)

  Exemple : /api/test/*,/api/playground/create

  Par défaut : /**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg,/**/*.pdf,/**/*.xlsx,/**/*.txt,/**/*.docs,/**/*.gif,/**/*.csv

• Enable printing HTTP request body : lorsqu'elle est activée, la sonde ajoute le champ http.request.body aux Spans client HTTP pour enregistrer le corps de la requête. La longueur de capture par défaut est 1024.

• Enable printing HTTP request header : lorsqu'elle est activée, le champ http.request.header est ajouté aux Spans client HTTP pour enregistrer l'en-tête de la requête.

• HTTP body length : la longueur maximale du corps de la requête HTTP capturé. La longueur par défaut est 1024.

• Include TraceId in HTTP response : lorsqu'elle est activée, la sonde ajoute le TraceId à l'en-tête de réponse avec la clé Eagleeye-TraceId.

• Enable printing HTTP response body : lorsqu'elle est activée, la sonde ajoute le champ http.response.body aux Spans serveur HTTP pour enregistrer le corps de la réponse.

• Enable printing HTTP response header : lorsqu'elle est activée, le champ http.response.header est ajouté aux Spans serveur HTTP pour enregistrer l'en-tête de la réponse.

• HTTP response body length : la longueur maximale du corps de la réponse HTTP capturé. La longueur par défaut est 1024.

• Write HTTP request header keys to Span : saisissez les clés d'en-tête, séparées par des virgules. La sonde ajoute un champ http.request.header.key aux Spans client HTTP pour chaque clé spécifiée.

• Write HTTP response header keys to Span : saisissez les clés d'en-tête, séparées par des virgules. La sonde ajoute un champ http.response.header.key aux Spans serveur HTTP pour chaque clé spécifiée.

Filtrage avancé des exceptions

• Collect Plugin Exceptions : spécifie s'il faut collecter les exceptions de plugin.

• Exception Filter Whitelist : si vous ne souhaitez pas voir certaines exceptions dans l'onglet Exception Analysis, saisissez les noms des exceptions que vous souhaitez masquer de la page.

Désactivez l'interrupteur Collect plugin exceptions pour empêcher l'enregistrement multiple de la même exception. Dans le champ Exception filter whitelist, vous pouvez saisir plusieurs noms d'exceptions séparés par des virgules (,), par exemple *mysql.MySQLError. Les exceptions correspondant à la liste d'autorisation sont toujours enregistrées dans les Spans. Cette fonctionnalité est disponible dans les versions 2.3.1 de la sonde et ultérieures.

Configuration des appels de base de données

Dans la section Database call configuration, configurez le seuil SQL lent et la longueur maximale des instructions SQL collectées, et spécifiez s'il faut afficher les valeurs des variables liées et les valeurs constantes dans les instructions SQL.

• Display bound variable values in SQL : capture les valeurs de variables liées aux paramètres PreparedStatement. Les modifications prennent effet sans redémarrage de l'application.

• Display constant values in SQL : tronque uniquement les instructions SQL sans traitement supplémentaire. Les modifications prennent effet sans redémarrage de l'application.

La valeur par défaut de Slow SQL threshold est 500 ms. Les requêtes dépassant ce seuil sont marquées comme des requêtes SQL lentes. La valeur par défaut de Maximum SQL length est 1024. Toute partie d'une instruction SQL dépassant cette limite est tronquée. La fonctionnalité Display bound variable values in SQL n'est prise en charge que pour MySQL. Après avoir configuré les paramètres, cliquez sur Save ou sur Save and Bulk Copy to Other Applications.

Protocoles de propagation de trace

Dans la section Trace propagation protocol settings, sélectionnez un protocole de propagation de trace selon vos besoins. Par défaut, la sonde utilise le protocole W3C. Vous pouvez également sélectionner Zipkin, Jaeger ou EagleEye.

Les versions 1.4.0 de la sonde et ultérieures prennent en charge le changement de protocole. Le mode de propagation prend en charge les modes Priority et Forced. En mode Priority, la sonde tente d'abord de lire l'en-tête du protocole sélectionné. Si l'en-tête n'existe pas, la sonde continue de détecter les en-têtes d'autres protocoles. En mode Forced, si l'en-tête du protocole sélectionné est manquant, la sonde génère un nouveau contexte de trace selon les spécifications de ce protocole.

Collecte de la sonde

Dans la section Probe collection configuration, définissez le nombre maximal de traces collectées par seconde et le niveau de journalisation de la sonde.

La valeur par défaut de Maximum traces per second est 100. La collecte de métriques personnalisées nécessite la version 2.0.0 de la sonde ou ultérieure. Enable Span reporting nécessite la version 1.8.3 de la sonde ou ultérieure. Span reporting name nécessite la version 1.7.0 de la sonde ou ultérieure. Séparez plusieurs clés par une virgule (,). Le filtrage de la collecte de métriques par défaut nécessite la version 2.3.0 de la sonde ou ultérieure.

La liste suivante décrit certains des paramètres :

• Custom Metric Collection : contrôle si l'agent collecte les métriques définies dans votre code avec le SDK OTel.

• Enable Span Reporting : cette fonctionnalité est activée par défaut. Si vous désactivez cette fonctionnalité, aucun Span n'est rapporté.

• Span Reporting Name : spécifie une liste d'autorisation des noms de Span à rapporter. Si ce champ est configuré, seuls les Spans avec des noms correspondants sont rapportés.

• Configuration de la collecte de métriques personnalisées : configurez le nom de portée de la métrique. Si vous ne configurez pas ce paramètre, toutes les métriques personnalisées sont collectées par défaut.

Default Metric Collection Filtering : filtre le rapport des types de métriques spécifiés. Vous pouvez sélectionner un ou plusieurs des types suivants :

• custom_entry : métriques personnalisées pour la surveillance des méthodes.

• http : métriques du serveur HTTP.

• http_client : métriques du client HTTP.

• rpc : métriques d'appel du serveur RPC.

• rpc_client : métriques d'appel du client RPC.

• sql : métriques d'accès à la base de données.

• nosql : métriques d'accès au service NoSQL.

• cache : métriques d'accès au service de cache.

• producer : métriques de publication de messages.

• consumer : métriques de consommation de messages.

• schedule : métriques du service de planification.

Paramètres avancés

Dans la section Advanced settings, configurez les calculs de percentile, l'échantillonnage des appels lents et des erreurs, ainsi que la longueur maximale des traces de pile collectées.

La valeur par défaut de Stack trace collection length est 4096. Après avoir configuré les paramètres, cliquez sur Save ou sur Save and Bulk Copy to Other Applications.

Copier les configurations vers d'autres applications

Si vous devez appliquer la même configuration à d'autres applications, vous pouvez copier les paramètres.

Configuration par défaut globale

Vous pouvez enregistrer la configuration actuelle en tant que configuration par défaut globale. Cette configuration s'applique ensuite par défaut lors de la création de nouvelles applications.

1. En bas de la page, cliquez sur Save Current App Settings as Global Default Configuration.

2. Si la boîte de dialogue Current settings not saved apparaît, cliquez sur OK pour enregistrer la configuration de l'application actuelle, puis cliquez à nouveau sur Save Current App Settings as Global Default Configuration.

3. Dans la boîte de dialogue qui s'affiche, cliquez sur Confirm.