Configurazione degli SDK X-Ray per Python

X-Ray SDK for Python ha una classe denominata xray_recorder che fornisce il registratore globale. È possibile configurare il registratore globale per personalizzare il middleware che crea segmenti per le chiamate in arrivo. HTTP

Plugin di servizio

Utilizzatelo plugins per registrare informazioni sul servizio che ospita l'applicazione.

Per usare un plugin, chiama configure sul tuo xray_recorder.

from aws_xray_sdk.core import xray_recorder
from aws_xray_sdk.core import patch_all

xray_recorder.configure(service='My app')
plugins = ('ElasticBeanstalkPlugin', 'EC2Plugin')
xray_recorder.configure(plugins=plugins)
patch_all()

Per configurare il registratore puoi anche utilizzare le variabili di ambiente, che hanno la precedenza sui valori impostati nel codice.

Configura i plugin prima applicare le patch alle librerie per memorizzare le chiamate a valle.

Utilizza SDK anche le impostazioni del plug-in per impostare il origin campo sul segmento. Indica il tipo di AWS risorsa che esegue l'applicazione. Quando si utilizzano più plugin, SDK utilizza il seguente ordine di risoluzione per determinare l'origine: ElasticBeanstalk > > EKS ECS >EC2.

Regole di campionamento

SDKUtilizza le regole di campionamento definite nella console X-Ray per determinare quali richieste registrare. La regola predefinita tiene traccia della prima richiesta ogni secondo e del cinque percento di eventuali richieste aggiuntive su tutti i servizi che inviano tracce a X-Ray. Crea regole aggiuntive nella console X-Ray per personalizzare la quantità di dati registrati per ciascuna delle tue applicazioni.

SDKApplica le regole personalizzate nell'ordine in cui sono definite. Se una richiesta corrisponde a più regole personalizzate, si SDK applica solo la prima regola.

È inoltre possibile configurare SDK per caricare le regole di campionamento da un documento. JSON SDKPossono utilizzare le regole locali come backup per i casi in cui il campionamento a raggi X non è disponibile o utilizzare esclusivamente regole locali.

{
  "version": 2,
  "rules": [
    {
      "description": "Player moves.",
      "host": "*",
      "http_method": "*",
      "url_path": "/api/move/*",
      "fixed_target": 0,
      "rate": 0.05
    }
  ],
  "default": {
    "fixed_target": 1,
    "rate": 0.1
  }
}

Questo esempio definisce una regola personalizzata e una regola predefinita. La regola personalizzata applica una frequenza di campionamento del cinque percento senza alcun numero minimo di richieste da tracciare per i percorsi. /api/move/ La regola predefinita tiene traccia della prima richiesta ogni secondo e del 10% delle richieste aggiuntive.

Lo svantaggio della definizione locale delle regole è che l'obiettivo fisso viene applicato da ciascuna istanza del registratore in modo indipendente, anziché essere gestito dal servizio X-Ray. Man mano che si installano più host, la tariffa fissa si moltiplica, rendendo più difficile il controllo della quantità di dati registrati.

Sì AWS Lambda, non è possibile modificare la frequenza di campionamento. Se la funzione viene chiamata da un servizio strumentato, le chiamate che hanno generato richieste campionate da quel servizio verranno registrate da Lambda. Se il tracciamento attivo è abilitato e non è presente alcuna intestazione di tracciamento, Lambda prende la decisione di campionamento.

Per configurare le regole di campionamento di backup, chiamate, come mostrato nell'esempio seguentexray_recorder.configure, dove rules è un dizionario di regole o il percorso assoluto di un JSON file contenente regole di campionamento.

xray_recorder.configure(sampling_rules=rules)

Per utilizzare solo regole locali, configura un registratore con una LocalSampler.

from aws_xray_sdk.core.sampling.local.sampler import LocalSampler
xray_recorder.configure(sampler=LocalSampler())

Puoi anche configurare il registratore globale per disabilitare il campionamento e analizzare tutte le richieste in entrata.

xray_recorder.configure(sampling=False)

Registrazione

SDKUtilizza il logging modulo integrato di Python con un livello di WARNING registrazione predefinito. Ottieni un riferimento al logger per la classe aws_xray_sdk e chiama setLevel per configurare il livello di log differenti per la libreria e il resto dell'applicazione.

logging.basicConfig(level='WARNING')
logging.getLogger('aws_xray_sdk').setLevel(logging.ERROR)

Utilizza i log di debug per identificare i problemi, come ad esempio dei sottosegmenti non chiusi, quando generi dei sottosegmenti manualmente.

Configurazione del registratore nel codice

Impostazioni aggiuntive sono disponibili tramite il metodo configure su xray_recorder.

from aws_xray_sdk.core import xray_recorder

xray_recorder.configure(context_missing='LOG_ERROR')

Configurazione del registratore con Django

Se utilizzi il framework Django, puoi utilizzare il file settings.py di Django per configurare le opzioni del registratore globale.

Per abilitare la configurazione del registratore in settings.py, aggiungi il middleware Django all'elenco delle applicazioni.

INSTALLED_APPS = [
    ...
    'django.contrib.sessions',
    'aws_xray_sdk.ext.django',
]

Configura le impostazioni disponibili in un dizionario denominato XRAY_RECORDER.

XRAY_RECORDER = {
    'AUTO_INSTRUMENT': True,
    'AWS_XRAY_CONTEXT_MISSING': 'LOG_ERROR',
    'AWS_XRAY_DAEMON_ADDRESS': '127.0.0.1:5000',
    'AWS_XRAY_TRACING_NAME': 'My application',
    'PLUGINS': ('ElasticBeanstalkPlugin', 'EC2Plugin', 'ECSPlugin'),
    'SAMPLING': False,
}

Variabili di ambiente

È possibile utilizzare le variabili di ambiente per configurare X-Ray for SDK Python. SDKSupporta le seguenti variabili:

Le variabili di ambiente sostituiscono i valori impostati nel codice.