Configuration du paquet « Python »

Cet objet instana.configurator.config offre une alternative native à Python aux variables d'environnement pour les options suivantes. Importez-le avec from instana.configurator import config.

AutoProfile génère et signale les profils de processus à Instana automatiquement et en continu. Pour en savoir plus sur les profils, consultez la section « Analyser les profils ».

Pour activer AutoProfile, définissez la variable d'environnement INSTANA_AUTOPROFILE=true. AutoProfile n'est pris en charge que pour une installation manuelle. Assurez-vous que le capteur « Instana » est initialisé dans le thread principal.

Le package Instana Python tente de communiquer avec l'agent Instana via l' 127.0.0.1 IP et, à défaut, via la passerelle par défaut de l'hôte pour les environnements conteneurisés. Si l'agent n'est disponible à aucun de ces emplacements, vous pouvez utiliser des variables d'environnement pour configurer l'emplacement où rechercher l'agent hôte d' Instana.

Les variables d'environnement doivent être définies dans l'environnement du processus en cours d'exécution.

export INSTANA_AGENT_HOST = '127.0.0.1'
export INSTANA_AGENT_PORT = '42699'
 

Voir aussi :

• Configuration de l'accès réseau des agents pour l' Kubernetes
• Référence générale : Variables d'environnement pour les capteurs de langue

Par défaut, l' Instana e met tout en œuvre pour nommer vos services de manière appropriée. Si, pour une raison quelconque, vous souhaitez personnaliser la manière dont les services sont nommés, vous pouvez le faire en définissant une variable d'environnement :

export INSTANA_SERVICE_NAME=myservice
 

Voir également la section « Référence générale : Variables d'environnement pour les capteurs de langue »

Utilisez INSTANA_PROCESS_NAME pour définir un libellé personnalisée pour l'entité d'infrastructure qui représente le processus Python.

Activer la propagation du contexte de traçage entre les appels asyncio.create_task asyncio.ensure_future et. Paramètre désactivé par défaut.

from instana.configurator import config

config['asyncio_task_context_propagation']['enabled'] = True
 

Vous pouvez également définir la variable d'environnement correspondante :

export INSTANA_ASYNCIO_TASK_CONTEXT_PROPAGATION="true"
 

En définissant ce paramètre sur INSTANA_DEBUG une valeur différente de zéro, vous activez des messages de journalisation supplémentaires, généralement utiles pour le développement et le dépannage.

export INSTANA_DEBUG="true"
 

Voir également la section « Référence générale : Variables d'environnement pour les capteurs de langue »

Ce package Instana inclut l'instrumentation automatique initialisée lors du chargement du package. Cette instrumentation fournit des informations de traçage distribué à votre tableau de bord Instana. Pour consulter la liste complète des instruments pris en charge, reportez-vous au document « Versions prises en charge ».

Vous pouvez désactiver l'instrumentation automatique (traçage) en définissant la variable d'environnement INSTANA_DISABLE_AUTO_INSTR , ce qui empêche le chargement de l'instrumentation intégrée au traceur.

export INSTANA_DISABLE_AUTO_INSTR="true"
 

Par défaut, l'outil Tracer de Instana Python ne capture que les segments de sortie pour lesquels il existe un segment d'entrée actif. Cependant, dans certains cas, il est nécessaire de suivre les segments de sortie qui se produisent sans segment d'entrée.

Pour configurer l'outil Tracer d' Python afin de tracer des segments de sortie autonomes, définissez la variable INSTANA_ALLOW_ROOT_EXIT_SPAN d'environnement sur 1 ou true comme suit :

export INSTANA_ALLOW_ROOT_EXIT_SPAN=1
 

Cette fonctionnalité est utile dans les cas suivants :

• Messages entrants provenant de bibliothèques de messagerie non prises en charge.
• Les requêtes effectuées via des protocoles non pris en charge, tels que le protocole « raw » Transmission Control Protocol ( TCP ) ou WebSocket.
• Tâches planifiées lancées en interne par d'autres applications.
• Exécution des scripts d' Python.

Dans certains cas sur cette plateforme, il se peut que le capteur « Python » ne parvienne pas à localiser et à contacter automatiquement l'agent hôte « Instana ». Pour résoudre ce problème, consultez la section « Configuration de l'accès réseau de l'agent pour l' Kubernetes » dans la documentation.

Voir aussi :

• Python -Communication de l'agent hôte
• Référence générale : Variables d'environnement pour les capteurs de langue

Lorsque la variable AUTOWRAPT_BOOTSTRAP=instana d'environnement est définie, le framework Django doit être automatiquement détecté et configuré. Si, pour une raison quelconque, vous préférez ou nécessitez une instrumentation manuelle de Django, vous pouvez à la place ajouter instana.instrumentation.django.middleware.InstanaMiddleware à votre liste MIDDLEWARE dans settings.py :

import os
import instana

# ... <snip> ...

MIDDLEWARE = [
    'instana.instrumentation.django.middleware.InstanaMiddleware',
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
 

À partir de la version 1.22.0 jusqu'à la version 2.5.3, le paquet Instana Python inclut une prise en charge manuelle de Pyramid. Pour ajouter de la visibilité à votre application Pyramide, suivez les étapes suivantes :

1. Assurez-vous que le paquet instana est ajouté au requirements.txt et installé dans l'environnement virtuel ou le conteneur.
2. Ajoutez import instana ceci au début de votre __init__.py fichier pour votre application Pyramid.
3. Ajoutez l'instrumentation Tween « Instana » à votre configuration.

import instana

with Configurator(settings=settings) as config:
    # ...
    config.include('instana.instrumentation.pyramid.tweens')
    # ...
 

L'image suivante présente un exemple de l'instrumentation d' Instana s dans votre configuration Pyramid :

Si l'option pyramid.tweens est définie dans votre configuration production.ini, vérifiez que instana.instrumentation.pyramid.tweens.InstanaTweenFactory est la première entrée de cette liste :

pyramid.tweens =
    instana.instrumentation.pyramid.tweens.InstanaTweenFactory
    # other tweens
 

Le package Instana Python comprend des intergiciels WSGI (Web Server Gateway Interface) et ASGI (Asynchronous Server Gateway Interface) pouvant être intégrés à n'importe quelle pile compatible. L'automatisation est disponible pour diverses piles, mais l'ajout manuel est également possible pour celles qui ne bénéficient pas encore d'une prise en charge automatique de la part d' Instana.

Une fois que vous avez installé le paquet Instana Python, utilisez les commandes suivantes :

import instana

from instana.middleware import InstanaWSGIMiddleware
# or
from instana.middleware import InstanaASGIMiddleware

# Wrap the wsgi app in Instana middleware (InstanaWSGIMiddleware)
wsgiapp = InstanaWSGIMiddleware(MyWSGIApplication())
 

Instana travaille actuellement à l'automatisation de l'instrumentation pour tous les principaux frameworks, mais en attendant, vous pouvez consulter des guides de démarrage rapide spécifiques pour les piles qui ne bénéficient pas encore d'une prise en charge automatique sur Instana.

Assurez-vous que enable-threads cette option est activée pour uwsgi.

Pour instrumenter votre application exécutée sous Gunicorn, veillez à lui passer --preload en argument.

Instana offre une surveillance approfondie des utilisateurs finaux qui relie les traces côté serveur aux événements du navigateur, vous offrant ainsi une vue d'ensemble complète, du serveur au navigateur.

Pour plus d'informations, consultez la page consacrée à la surveillance des utilisateurs finaux.

Vous pouvez configurer le filtrage des spans en utilisant l'une des méthodes suivantes. Lorsque plusieurs méthodes sont utilisées, le filtrage s'applique selon l'ordre de priorité suivant (du plus élevé au plus faible) :

1. YAML configuration (INSTANA_CONFIG_PATH)
2. INSTANA_TRACING_FILTER_* variables d'environnement
3. Configuration dans le code (config["tracing"]["filter"])
4. Configuration de l'agent (configuration.yaml)

INSTANA_CONFIG_PATH=/path/to/your/configuration.yaml
 

# Exclude all HTTP spans
INSTANA_TRACING_FILTER_EXCLUDE_HTTP_ATTRIBUTES="type;http"

# Include only health check endpoints
INSTANA_TRACING_FILTER_INCLUDE_HEALTH_ATTRIBUTES="http.url;/health"

# Exclude all messaging spans
INSTANA_TRACING_FILTER_EXCLUDE_CATEGORY_ATTRIBUTES="category;messaging"

# Include only specific Kafka topic and operations
INSTANA_TRACING_FILTER_INCLUDE_KAFKA_ATTRIBUTES="kafka.topic;topic1;strict|kafka.access;consume,send"

# Exclude all exit spans
INSTANA_TRACING_FILTER_EXCLUDE_KIND_ATTRIBUTES="kind;exit"

from instana.configurator import config

config["tracing"]["filter"] = {
    "exclude": [
        {
            "name": "Exclude all health check endpoints",
            "attributes": [
                {"key": "http.url", "values": ["/health"], "match_type": "contains"}
            ],
        }
    ],
    "include": [
        {
            "name": "Include specific internal health endpoint",
            "attributes": [
                {"key": "http.url", "values": ["/internal/health"], "match_type": "strict"}
            ],
        }
    ],
}

tracing:
  filter:
    deactivate: <boolean>
    <policy>: # exclude | include
      - name: <string>
        suppression: <boolean>
        attributes:
          - key: <string> # category | kind | type | span attribute (e.g., kafka.access, http.host)
            values: <list of strings>
            match_type: <string> # strict | startswith | endswith | contains

tracing:
  filter:
    exclude:
      - name: Exclude all health check endpoints
        attributes:
          - key: http.url
            values: [/health]
            match_type: contains
      - name: Exclude all messaging spans
        attributes:
          - key: category
            values: [messaging]
            match_type: strict
    include:
      - name: Include specific internal health endpoint
        attributes:
          - key: http.url
            values: [/internal/health]
            match_type: strict

Les catégories sont des ensembles de bibliothèques regroupées selon un type commun de technologie ou de protocole. Pour l'instant, vous ne pouvez désactiver les balises span que pour la logging catégorie.

Vous pouvez désactiver les balises `span` en utilisant l'une des options suivantes. Lorsque plusieurs méthodes sont utilisées, la configuration est appliquée selon l'ordre de priorité suivant (du plus élevé au plus faible) :

1. INSTANA_CONFIG_PATH (Archives de YAML )
2. INSTANA_TRACING_DISABLEvariable d'environnement
3. Configuration dans le code (config["tracing"]["disable"])
4. Configuration de l'agent (configuration.yaml)