Configuration du collecteur « Python »

Utilisez les commandes suivantes pour instrumenter Bottle WSGI :

# Import Instana and the Instana WSGI middleware wrapper
import instana
from instana.middleware import InstanaWSGIMiddleware

from bottle import Bottle, run

app = Bottle()

@app.route('/hello')
def hello():
    return "Hello World!"

# Wrap the application with the Instana WSGI Middleware
app = InstanaWSGIMiddleware(app)

# Alternative method for reference
# app = InstanaWSGIMiddleware(bottle.default_app())

run(app, host='localhost', port=8080)
 

Utilisez les commandes suivantes pour instrumenter le WSGI d' CherryPy :

import cherrypy

# Import Instana and the Instana WSGI middleware wrapper
import instana
from instana.middleware import InstanaWSGIMiddleware

# My CherryPy application
class Root(object):
    @cherrypy.expose
    def index(self):
        return "hello world"

cherrypy.config.update({'engine.autoreload.on': False})
cherrypy.server.unsubscribe()
cherrypy.engine.start()

# Wrap the application with the Instana WSGI Middleware
wsgiapp = InstanaWSGIMiddleware(cherrypy.tree.mount(Root()))
 

Dans cet exemple, nous utilisons uwsgi comme serveur web et démarrons avec :

uwsgi --socket 127.0.0.1:8080 --enable-threads --protocol=http --wsgi-file mycherry.py --callable wsgiapp -H ~/.local/share/virtualenvs/cherrypyapp-C1BUba0z
 

Où ~/.local/share/virtualenvs/cherrypyapp-C1BUba0z est le chemin d'accès à mon environnement virtuel local à partir de l'environnement pip

Le framework Falcon peut également être instrumenté via le wrapper WSGI de la manière suivante :

import falcon

# Import Instana and the Instana WSGI middleware wrapper
import instana
from instana.middleware import InstanaWSGIMiddleware

app = falcon.API()

# ...

# Wrap the application with the Instana WSGI Middleware
app = InstanaWSGIMiddleware(app)
 

Ensuite, lancez votre pile avec uwsgi --http :9000 --enable-threads --module=myfalcon.app à titre d'exemple

Instana prend en charge les applications basées sur gevent1.4 et les versions ultérieures.

Si vous importez manuellement le package Instana Python, assurez-vous que l'importation de gevent et l'application du correctif Monkey ont lieu en premier.

    from gevent import monkey
    monkey.patch_all()
    import instana # <--- after the gevent monkey patching of stdlib
 

À partir de la version Instana Python Tracer 2.5.0, le traceur s'exécute monkey.patch_all() automatiquement lorsque le webhook AutoTrace est utilisé ou que la méthode d'activation sans modification du code est employée. Vous pouvez affiner ce « monkey patching » en définissant la variable INSTANA_GEVENT_MONKEY_OPTIONS d'environnement. Grâce à cette liste séparée par des virgules, vous pouvez indiquer les modules à inclure ou à exclure du « monkey patching », à MONKEY OPTIONS l'instar de la fonction ` gevent.monkey.main ` de gevent.

Les exemples suivants présentent les options disponibles pour personnaliser les modules en vue du « monkey patching » :

export INSTANA_GEVENT_MONKEY_OPTIONS='--no-socket, --dns, --no-time, --select, --no-ssl'
 

export INSTANA_GEVENT_MONKEY_OPTIONS='no-socket, dns, no-time, select, no-ssl'
 

export INSTANA_GEVENT_MONKEY_OPTIONS='no-socket,dns,no-time,select,no-ssl'
 

Si vous utilisez Django avec gevent et la fonctionnalité d'autotracing de Instana, veillez à définir la variable DJANGO_SETTINGS_MODULE d'environnement avant le démarrage de l'autotracing. Pour plus d'informations sur la variable DJANGO_SETTINGS_MODULE d'environnement, consultez la documentation de Django.

Si ce niveau de personnalisation est encore insuffisant, utilisez la méthode d'activation des paquets Activation par modification du code.

Cet outil d' Python, « instrumentation », crée un thread d'arrière-plan léger chargé de collecter et de transmettre périodiquement les métriques du processus. Par défaut, le GIL et le multithreading sont désactivés sous uWSGI. Si vous souhaitez instrumenter votre application exécutée sous uWSGI,, assurez-vous d'activer les threads en passant la --enable-threads commande (ou enable-threads = true dans le fichier INI). Pour plus d'informations, consultez la documentation de uWSGI.

uwsgi --socket 0.0.0.0:5000 --protocol=http -w wsgi -p 4 --enable-threads
 

[uwsgi]
http = :5000
master = true
processes = 4
enable-threads = true # required
 

Cet outil d' Python, « instrumentation », crée un thread d'arrière-plan léger chargé de collecter et de transmettre périodiquement les métriques du processus. Par défaut, les processus du code de l'application après les travailleurs sont forkés dans Gunicorn. Si vous souhaitez instrumenter votre application exécutée sous Gunicorn, veillez à activer le préchargement en passant la --preload commande. Pour plus d'informations, voir la documentation Gunicorn.

Pour exécuter Gunicorn avec le préchargement, utilisez la commande suivante, illustrée dans cet exemple :

gunicorn -w 4 --preload "file:app"
 

Pour utiliser Gunicorn avec un fichier de configuration, utilisez un fichier Python avec les variables suivantes. Ajouter '-c file_name.py à la commande Gunicorn.

bind = "0.0.0.0:8000"
workers = 4
preload_app = true  # required
 

Vous pouvez configurer les points de terminaison à ignorer en utilisant les variables d'environnement suivantes pour filtrer les points de terminaison par service :

• INSTANA_IGNORE_ENDPOINTS_PATH : Configurer le filtrage via un fichier d' YAML s externe.
• INSTANA_IGNORE_ENDPOINTS : Exclure les intervalles en se basant uniquement sur les noms des méthodes.

Pour ignorer les points de terminaison en utilisant la méthode de configuration intégrée au code, ajoutez la configuration suivante au src/instana/configurator.py fichier :

config["tracing"]["ignore_endpoints"] = { "redis": ["get", "type"] }
 

Cette configuration exclut les GET commandes TYPE et du paquet Redis du traçage.

Pour ignorer tous les points de terminaison du paquet « Redis », ajoutez la configuration suivante au src/instana/configurator.py fichier :

config["tracing"]["ignore_endpoints"] = { "redis": [] }
 

Pour filtrer plusieurs services, vous pouvez utiliser la configuration suivante :

config["tracing"]["ignore_endpoints"] = {
    "redis": ["get", "type"],
    "dynamodb": ["query", "scan"],
    "kafka": ["send"]
}
 

Cette configuration filtre les segments suivants :

• GET et TYPE les commandes dans Redis
• QUERY et SCAN les commandes dans DynamoDB
• SEND méthode dans ` Kafka ` et tous les segments en aval

L'exemple suivant illustre le filtrage par méthode et par point de terminaison :

config["tracing"]["ignore_endpoints"] = {
    "kafka": [
        { methods: ["consume"], endpoints: ["topic1", "topic2"] },
        { methods: ["send"], endpoints: ["topic3"] }
    ]
}
 

Cette configuration filtre les segments suivants :

• CONSUME méthode pour topic1 et topic2 dans l' Kafka e et toutes les travées en aval
• SEND méthode pour topic3 l' Kafka et toutes les portées en aval

Vous pouvez utiliser les deux options de filtrage (méthode uniquement et méthode et point de terminaison) dans la même configuration.

Pour exclure les points de terminaison à l'aide de la méthode de configuration de l'agent, ajoutez la ignore-endpoints configuration au fichier de configuration.yaml l'agent. Pour plus d'informations, consultez la section « Ignorer les points de terminaison ».

Définissez la variable INSTANA_CONFIG_PATH d'environnement sur un fichier de configuration local d' YAML, en utilisant la spécification suivante :

tracing:
  disable:
    - <category_or_type>: <boolean>

La disable clé peut contenir une liste de catégories ou de type noms. Un type nom désigne toute référence à un framework, une bibliothèque ou un outil d'instrumentation pris en charge par l'outil de traçage Instana Python. Les configurations type individuelles prévalent sur les paramètres de category leur niveau supérieur, quel que soit l'ordre dans lequel elles sont définies. Cette approche permet un contrôle précis, grâce auquel certaines instrumentations spécifiques peuvent rester activées même lorsque leur catégorie générale est désactivée. L'exemple de configuration suivant désactive toutes les étendues de base de données, à l'exception de celles destinées à Redis :

com.instana.tracing:
  disable:
    - databases: true
    - redis: false

Vous pouvez utiliser la variable INSTANA_TRACING_DISABLE d'environnement pour désactiver les balises `span`, comme le montre l'exemple suivant :

# Disable Redis spans
INSTANA_TRACING_DISABLE=redis

# Disable all logging spans
INSTANA_TRACING_DISABLE=logging

# Disable multiple technologies
INSTANA_TRACING_DISABLE=redis,logging

Pour désactiver les balises « span » d' Redis s à l'aide de la configuration de l'agent, ajoutez la disable configuration suivante au fichier de configuration.yaml l'agent :

com.instana.tracing:
  disable:
    - redis: true

Pour désactiver les logging intervalles de catégorie à l'aide de la configuration de l'agent, ajoutez la disable configuration suivante au fichier de configuration.yaml l'agent :

com.instana.tracing:
  disable:
    - logging: true