Traitement des incidents

Pour vérifier que le collecteur Go est correctement intégré à votre application, procédez comme suit :

1. Initialiser le collecteur « Go »

   Vous devez initialiser le collecteur « Go » au démarrage de votre application à l'aide de la InitCollector fonction du package « Instana » :

   import (
       instana "github.com/instana/go-sensor"
   )
   
   func main() {
       // Initialize the collector with service name and other options
       collector := instana.InitCollector(&instana.Options{
           Service:           "your-service-name",
           EnableAutoProfile: true,
           Tracer:            instana.DefaultTracerOptions(),
       })
   
       // Your application code here
   }

   Principales options de configuration :

   • Service (obligatoire) : Nom de votre service tel qu'il apparaît sur Instana.
   • EnableAutoProfile (facultatif) : Active la fonctionnalité de profilage automatique.
   • Tracer (facultatif) : Permet de configurer les options de traçage.
2. Vérifier le raccordement du collecteur

   Une fois l'initialisation terminée, vérifiez les journaux de votre application pour détecter d'éventuels problèmes de connexion. Si le collecteur est correctement connecté à l'agent d' Instana, aucun message d'erreur ne s'affiche.

3. Utiliser des bibliothèques d'instrumentation

   Pour une surveillance complète, utilisez les bibliothèques d'instrumentation d' Instana afin d'instrumenter des composants spécifiques de votre application. Ces bibliothèques créent des intervalles et collectent des métriques pour diverses opérations.

   Instana fournit plusieurs bibliothèques d'instrumentation pour les packages d' Go s les plus courants.

   Pour plus d'informations, consultez les bibliothèques d'instruments suivantes :

   • HTTP instrumentation des serveurs
   • Instrumentation de bases de données via SQL
   • GraphQL instrumentation
   • Redis instrumentation
   • MongoDB instrumentation
   • Kafka instrumentation
   • Autres ensembles d'instruments
4. Configurez correctement les variables d'environnement

   Assurez-vous que toutes les variables d'environnement nécessaires sont correctement configurées pour votre scénario de déploiement. Des variables d'environnement manquantes ou mal configurées peuvent affecter le fonctionnement du traceur Instana Go, ce qui peut entraîner une surveillance incomplète ou des problèmes de configuration.

   Pour plus d'informations sur les variables d'environnement requises et leur configuration, consultez la section « Configuration du collecteur d' Go s ».

Pour résoudre les problèmes de réseau, procédez au dépannage comme suit :

• Vérifiez que le processus « Go » peut se connecter à l'agent hôte sur le même hôte via le port 42699. Pour plus d'informations sur la visibilité réseau requise, consultez la section « Configuration réseau requise pour l'agent hôte d' Instana ».

• Dans les plateformes conteneurisées, vérifiez la visibilité réseau entre le conteneur contenant l'application à tracer et le conteneur de l'agent hôte d' Instana. Assurez-vous qu'il n'y a aucun problème de configuration du réseau superposé lorsque le conteneur d'application à tracer tente de se connecter au conteneur de l'agent d' Instana s sur le même hôte.

• Assurez-vous que le collecteur Go utilise l'adresse IP ou le nom de domaine DNS correct pour communiquer avec l'agent Instana. Si vous devez modifier l'adresse réseau, vous pouvez demander au collecteur d' Go s d'utiliser la variable INSTANA_AGENT_HOST d'environnement.

• Assurez-vous que l'agent hôte écoute sur le port 42699. Si vous devez rediriger le port parce que l'agent hôte n'écoute pas sur le port 42699 mais sur un autre, vous pouvez configurer le collecteur pour qu'il utilise un autre port à l'aide de la variable INSTANA_AGENT_PORT d'environnement.

Si aucune des solutions précédentes ne vous aide à résoudre le problème, ouvrez un ticket d'assistance.

La propagation du contexte est le mécanisme qui permet de transmettre des informations de traçage entre les différents composants de votre application. Dans le capteur d' Go, cette propagation s'effectue principalement via le package context d' Go, à l'aide de instana.ContextWithSpan() et instana.SpanFromContext() .

L'exemple suivant montre comment propager correctement le contexte depuis un point de terminaison d' HTTP s vers une opération sur une base de données SQL :

import (
    "fmt"
    "io"
    "net/http"

    _ "github.com/go-sql-driver/mysql"
    instana "github.com/instana/go-sensor"
)

func main() {
    // Initialize the Instana collector
    col := instana.InitCollector(&instana.Options{
        Service: "your-service-name",
        Tracer:  instana.DefaultTracerOptions(),
    })

    // HTTP handler with SQL database operation
    http.HandleFunc("/api/users", instana.TracingHandlerFunc(col, "/api/users", func(w http.ResponseWriter, req *http.Request) {
        // Open an instrumented database connection
        db, err := instana.SQLInstrumentAndOpen(col, "mysql", "user:password@tcp(localhost:3306)/mydb")
        if err != nil {
            http.Error(w, "Database connection failed", http.StatusInternalServerError)
            return
        }
        defer db.Close()

        // The request context already contains the span from the HTTP handler
        ctx := req.Context()

        // Use the same context for the database query to maintain the trace
        rows, err := db.QueryContext(ctx, "SELECT id, name FROM users LIMIT 10")
        if err != nil {
            http.Error(w, "Query failed", http.StatusInternalServerError)
            return
        }
        defer rows.Close()

        // Process the query results
        var result string
        for rows.Next() {
            var id int
            var name string
            if err := rows.Scan(&id, &name); err != nil {
                continue
            }
            result += fmt.Sprintf("User: %d - %s\n", id, name)
        }

        io.WriteString(w, result)
    }))

    http.ListenAndServe(":8080", nil)
}

Vous devez respecter les bonnes pratiques suivantes :

• Transmettez toujours le contexte : transmettez le contexte contenant la balise <span> à toutes les opérations qui prennent en charge le contexte.

• Utilisez des méthodes sensibles au contexte : utilisez des méthodes qui acceptent un paramètre de contexte, par exemple QueryContext pour les bases de données ou les méthodes client instrumentées.

• Extraire et injecter correctement les segments : lorsque vous utilisez l'instrumentation manuelle, utilisez SpanFromContext() pour extraire les segments et ContextWithSpan() pour les injecter.

• Conserver le contexte entre les goroutines : lors de la création de goroutines, transmettez le contexte afin d'assurer la continuité de la traçabilité.

• Consultez les bibliothèques d'instrumentation : utilisez les bibliothèques d'instrumentation d' Instana pour les paquets courants, tels que Redis, MongoDB, ou les bases de données SQL, car elles gèrent automatiquement la propagation du contexte.

Vous devez éviter les erreurs suivantes :

• Créer un nouveau contexte au lieu d'utiliser celui de la requête.
• Ne pas transmettre le contexte aux opérations qui le prennent en charge.
• Utiliser des méthodes qui ne tiennent pas compte du contexte alors qu'il existe des alternatives qui en tiennent compte.
• Perte de contexte lors du franchissement des limites entre services.

En suivant ces recommandations, vous vous assurez que vos traces distribuées sont correctement connectées, ce qui vous offre une visibilité complète sur les performances de votre application.

Pour garantir des performances optimales et bénéficier des dernières fonctionnalités, assurez-vous d'utiliser la dernière version du SDK Tracer d' Instana Go :

1. Vérifiez la version actuelle dans votre go.mod fichier :

   require (
       github.com/instana/go-sensor v1.x.y
   )

   Consultez la dernière version disponible sur GitHub ou la section « Environnements d'exécution pris en charge ».

2. Si nécessaire, effectuez la mise à jour vers la dernière version :

   go get -u github.com/instana/go-sensor

Le SDK Tracer d' Instana Go est conçu pour fonctionner avec certaines versions d' Go. Vérifiez la compatibilité comme suit :

1. Vérifiez la version actuelle d' Go :

   go version

2. Assurez-vous que la version de votre Go est compatible avec celle du SDK Tracer de Instana Go.

En vous assurant d'utiliser les dernières versions compatibles, vous pouvez éviter de nombreux problèmes courants et profiter des dernières fonctionnalités et améliorations du SDK Tracer d' Instana Go.

Pour collecter les journaux de débogage, procédez comme suit :

1. Activez la journalisation de débogage en définissant les variables d'environnement suivantes :

   export INSTANA_DEBUG=true
   export INSTANA_LOG_LEVEL=debug
    

2. Redémarrez votre application et reproduisez le problème.

3. Récupérez les journaux de l'application contenant les informations de débogage.

Pour collecter les journaux des agents provenant de différents environnements hôtes, consultez les sections suivantes :

Veuillez rassembler les informations suivantes concernant votre environnement :

• Type de déploiement de l'application :

  • Kubernetes (préciser la version et la distribution)
  • Docker (indiquer la version)
  • machine virtuelle
  • Bare metal
  • Sans serveur ( AWS Lambda, Google, Cloud Functions et autres services cloud)

• Informations sur le système d'exploitation :

  • Linux
  • macOS
  • Windows
  • Autres systèmes d'exploitation
• Go Version d'exécution : exécutez la commande suivante pour identifier la version :

  go version
   

• Instana Go Version du SDK Tracer que vous utilisez : exécutez la commande suivante pour identifier la version :

  # Extract Instana Go Tracer SDK version
  grep "github.com/instana/go-sensor" go.mod > go-sensor-version.txt

• Nom et version des bibliothèques d'instrumentation Tracer d' Go s que vous utilisez :

  github.com/instana/go-sensor/instrumentation/instasql v1.x.y
  github.com/instana/go-sensor/instrumentation/instaredis v1.x.y
  # etc.

  Exécutez la commande suivante pour extraire les bibliothèques :

  # Extract instrumentation libraries
  grep -r "github.com/instana/go-sensor/instrumentation" go.mod >> instrumentation-library-versions.txt