Profilazione delle applicazioni Python

Questa pagina descrive come modificare l'applicazione Python per acquisire profilazione dei dati e l'invio di questi dati al tuo account Google Cloud progetto. Per informazioni generali sulla profilazione, consulta Concetti di profilazione.

Tipi di profilo per Python:

• Tempo CPU
• Tempo reale (thread principale)

Versioni del linguaggio Python supportate:

• Python 3.6 o superiore.

Versioni dell'agente di profilazione supportate:

• È supportata la versione più recente dell'agente. In genere, le release precedenti a un anno non sono supportate. Ti consigliamo di utilizzare la versione dell'agente rilasciata più di recente.

Sistemi operativi supportati:

• Linux. Il profiling delle applicazioni Python è supportato per i kernel Linux la cui libreria C standard è implementata con glibc o con musl. Per informazioni sulla configurazione specifiche per i kernel Linux Alpine, consulta Esecuzione su Linux Alpine.

Ambienti supportati:

• Compute Engine
• Google Kubernetes Engine (GKE)
• Ambiente flessibile di App Engine
• Ambiente standard di App Engine (richiede l'ambiente di runtime di Python 3)
• Al di fuori di Google Cloud (per informazioni sui requisiti di configurazione aggiuntivi, consulta Eseguire il profiling delle applicazioni in esecuzione all'esterno di Google Cloud).

Attivazione dell'API Profiler

Prima di utilizzare l'agente di profilazione, assicurati che l'API Profiler di base sia abilitata. Puoi controllare lo stato dell'API e abilitare e, se necessario, utilizzando Google Cloud CLI la console Google Cloud:

Interfaccia a riga di comando gcloud

1. Se non hai ancora installato Google Cloud CLI sulla tua workstation, consulta la documentazione di Google Cloud CLI.

2. Esegui questo comando:

   gcloud services enable cloudprofiler.googleapis.com
   

Per ulteriori informazioni, consulta gcloud services.

Console Google Cloud

1. Enable the required API.

   Enable the API

2. Se viene visualizzato il messaggio API abilitata, significa che l'API è già abilitata. In caso contrario, fai clic sul pulsante Attiva.

Utilizzo di Cloud Profiler

Per le best practice sull'utilizzo di Python, consulta Configurazione di un ambiente di sviluppo Python.

Compute Engine

Per Compute Engine, segui questi passaggi:

1. Installa il compilatore C/C++ e gli strumenti di sviluppo:

   sudo apt-get install -y build-essential
   

2. Installa pip:

   sudo apt-get install -y python3-pip
   

3. Installa il pacchetto Profiler:

   pip3 install google-cloud-profiler
   

4. Importa il modulo googlecloudprofiler e richiamare la funzione googlecloudprofiler.start il prima possibile nel codice di inizializzazione:

   import googlecloudprofiler
   
   
   def main():
       # Profiler initialization. It starts a daemon thread which continuously
       # collects and uploads profiles. Best done as early as possible.
       try:
           googlecloudprofiler.start(
               service="hello-profiler",
               service_version="1.0.1",
               # verbose is the logging level. 0-error, 1-warning, 2-info,
               # 3-debug. It defaults to 0 (error) if not set.
               verbose=3,
               # project_id must be set if not running on GCP.
               # project_id='my-project-id',
           )
       except (ValueError, NotImplementedError) as exc:
           print(exc)  # Handle errors here

   Devi specificare il parametro service nella funzione start. A filtrando in base alla versione dell'applicazione nel profiler specifica il parametro service_version. Per informazioni sulla risoluzione dei problemi e sulle eccezioni, consulta la sezione Risoluzione dei problemi.

GKE

Nota: se attivi la federazione delle identità per i carichi di lavoro per GKE su un cluster, assicurati di aggiungere il ruolo Agente di Cloud Profiler (roles/cloudprofiler.agent) all'account di servizio Kubernetes. Per ulteriori informazioni, consulta Utilizzare la federazione delle identità per i carichi di lavoro per GKE.

Per GKE, svolgi i seguenti passaggi:

1. Modifica il tuo Dockerfile per installare il pacchetto Profiler:

   FROM python:3
   ...
   RUN apt-get update && apt-get install -y build-essential python3-pip
   RUN pip3 install google-cloud-profiler
   

2. Importa il modulo googlecloudprofiler e chiama la funzione googlecloudprofiler.start il prima possibile nel codice di inizializzazione:

   import googlecloudprofiler
   
   
   def main():
       # Profiler initialization. It starts a daemon thread which continuously
       # collects and uploads profiles. Best done as early as possible.
       try:
           googlecloudprofiler.start(
               service="hello-profiler",
               service_version="1.0.1",
               # verbose is the logging level. 0-error, 1-warning, 2-info,
               # 3-debug. It defaults to 0 (error) if not set.
               verbose=3,
               # project_id must be set if not running on GCP.
               # project_id='my-project-id',
           )
       except (ValueError, NotImplementedError) as exc:
           print(exc)  # Handle errors here

   Devi specificare il parametro service nella funzione start. Per eseguire il filtraggio in base alla versione dell'applicazione nell'interfaccia di Profiler, specifica il parametro service_version. Per informazioni sulla risoluzione dei problemi e sulle eccezioni, consulta la sezione Risoluzione dei problemi.

Ambiente flessibile

Per l'ambiente flessibile di App Engine:

1. Aggiungi google-cloud-profiler al file requirements.txt.

2. Importa il modulo googlecloudprofiler e chiama la funzione googlecloudprofiler.start il prima possibile nel codice di inizializzazione.

Per App Engine, i valori service e service_version sono derivati dal tuo ambiente operativo. Per informazioni sulla risoluzione dei problemi e sulle eccezioni, consulta Risoluzione dei problemi.

Ambiente standard

Per l'ambiente standard di App Engine, che richiede l'utilizzo dell'ambiente di runtime di Python 3:

1. Aggiungi google-cloud-profiler al tuo file requirements.txt.

2. Importa il modulo googlecloudprofiler e chiama la funzione googlecloudprofiler.start il prima possibile nel codice di inizializzazione.

Per App Engine, service e service_version sono ricavati dall'ambiente operativo. Per informazioni sulla risoluzione dei problemi e sulle eccezioni, consulta la sezione Risoluzione dei problemi.

start funzione

La funzione googlecloudprofiler.start crea un thread daemon che raccoglie e carica continuamente i profili. Dovresti chiama start una volta e il prima possibile nella tua domanda.

Parametro	Descrizione
service^1	(Obbligatorio) Il nome del servizio di cui viene creato il profilo. Per limitazioni sul nome del servizio, vedi Argomenti Nome servizio e versione.
service_version^1	(Facoltativo) La versione del servizio che viene profilato. Per limitazioni sulla versione del servizio, vedi Argomenti Nome servizio e versione.
verbose	(Facoltativo) Il livello di logging. Per maggiori dettagli sul dei livelli di logging, consulta Logging agente. Il valore predefinito è 0 (Errore).
project_id^2	(Facoltativo) Il tuo ID progetto Google Cloud.
disable_cpu_profiling	(Facoltativo) Per disattivare il profiling del tempo della CPU, imposta disable_cpu_profiling=True. Questo parametro è supportato solo per Python 3.2 e versioni successive. Per tutte le altre versioni di Python, il profiling del tempo della CPU non è supportato e questo parametro viene ignorato. Il valore predefinito è False.
disable_wall_profiling	(Facoltativo) Per disattivare il profilo della parete, imposta disable_wall_profiling=True. Questo parametro è supportato per Python 3.6 e versioni successive. Per tutte le altre versioni di Python, il profiling della parete non è supportato e questo parametro viene ignorato. Per limitazioni relative alla funzione start durante la profilazione del muro sia attiva, consulta la sezione Limitazioni. Il valore predefinito è False.

¹ Solo per Compute Engine e GKE. Per App Engine, il valore viene ricavato dall'ambiente.
² Per Google Cloud, il valore deriva da dell'ambiente. Per gli ambienti non Google Cloud, devi fornire un valore. Per informazioni, vedi Profilazione delle applicazioni in esecuzione al di fuori di Google Cloud.

Analisi dei dati

Dopo che Profiler ha raccolto i dati, puoi visualizzare e analizzare questi dati utilizzando l'interfaccia Profiler.

Nella console Google Cloud, vai alla pagina Profiler:

Vai a Profiler

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Argomenti nome e versione del servizio

Quando carichi l'agente Profiler, specifichi un argomento service-name e un un argomento facoltativo service-version per configurarlo.

Nota: nell'ambiente flessibile di App Engine non devi specificare questi argomenti, poiché vengono ricavati dall'ambiente.

Il nome del servizio consente a Profiler di raccogliere dati di profilazione per tutti di repliche di quel servizio. Il servizio di profilazione garantisce un tasso di raccolta di un profilo al minuto, in media, per ogni nome di servizio in tutte le versioni e le zone dei servizi combinati.

Ad esempio, se hai un servizio con due versioni in esecuzione su repliche in tre zone, il profiler creerà in media 6 profili al minuto per quel servizio.

Se utilizzi nomi di servizi diversi per le repliche, il servizio verrà sottoposto a profilazione più spesso del necessario, con un overhead di conseguenza più elevato.

Quando selezioni il nome di un servizio:

• Scegli un nome che rappresenti chiaramente il servizio nella tua applicazione dell'architettura. La scelta del nome del servizio è meno importante se esegui un solo servizio o un'unica applicazione. È più importante se la tua applicazione viene eseguita come un insieme di microservizi, ad esempio.

• Assicurati di non utilizzare valori specifici per il processo, ad esempio un ID processo, nella stringa service-name.

• La stringa del nome del servizio deve corrispondere a questa espressione regolare:

  ^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$

Una buona linea guida è utilizzare una stringa statica come imageproc-service come nome del servizio.

La versione del servizio è facoltativa. Se specifichi la versione del servizio, Profiler può aggregare le informazioni di profilazione di più istanze e visualizzarle correttamente. Può essere usato per contrassegnare versioni diverse dei servizi durante il loro deployment. L'interfaccia utente di Profiler consente di filtrare i dati in base alla versione del servizio. In questo modo, puoi confrontare il rendimento delle versioni precedenti e successive del codice.

Il valore dell'argomento service-version è una stringa in formato libero, ma valori per questo argomento generalmente sono i numeri di versione, ad esempio 1.0.0 o 2.1.2.

Logging agente

Per impostazione predefinita, l'agente di profilazione registra i messaggi con un livello di gravità pari a error. Per configurare l'agente in modo che registri i messaggi con livelli di gravità più bassi, specificare il parametro verbose all'avvio dell'agente. Per verbose sono supportati quattro valori:

• 0 : errore
• 1 : avviso
• 2: informativo
• 3 : debug

Se imposti il parametro verbose su 1 nella chiamata a start, i messaggi con un livello di gravità Warning o Error vengono registrati, mentre i messaggi Informational e Debug vengono ignorati.

Per registrare tutti i messaggi, imposta verbose su 3 all'avvio dell'agente:

googlecloudprofiler.start(service='service_name', verbose=3)

Risoluzione dei problemi

Questa sezione elenca limitazioni, eccezioni e problemi noti specifici alla profilazione delle applicazioni Python. Per assistenza in merito ai problemi comuni, consulta la sezione Risoluzione dei problemi.

Limitazioni

Tipo di profilo

Restrizioni e limitazioni

Tempo totale di esecuzione

Solo profilazione del thread principale. La funzione del profilo start deve essere chiamata dal thread principale. Il gestore di indicatori Profiler viene eseguito solo nel thread principale. Se il thread principale non può essere eseguito, nessuna profilazione l'acquisizione dei dati. Nota: non attivare il profiling della parete se la tua applicazione contiene un numero elevato di thread. L'utilizzo dei profili Wall in questa configurazione comporta prestazioni lente e l'assenza di dati del profilo.

Eccezioni

Errore	Causa	Soluzione
NotImplementedError lanciato durante start	Applicazione eseguita in un ambiente non Linux.	Esegui la tua applicazione in un ambiente Linux.
ValueError lanciato durante start	Gli argomenti della funzione start non sono validi e sono necessari informazioni non possono essere determinate dalle variabili di ambiente argomenti o profilazione se sia la profilazione del tempo di CPU che il tempo di esecuzione la profilazione è disabilitata.	Assicurati che il nome e la versione del servizio soddisfino i requisiti definiti in Argomenti Nome servizio e versione. Se la profilazione del wall è attiva, assicurati che start viene chiamato dal thread principale. Assicurati di utilizzare una versione supportata di Python che la profilazione del tempo di CPU o del tempo di esecuzione sia attiva. Per ulteriori informazioni, consulta la funzione start. Verifica di aver specificato il parametro project_id su start se esegui l'operazione al di fuori di Google Cloud. Per ulteriori informazioni, vedi Funzione start.

Problemi noti

Comportamento	Causa	Soluzione
Non sono presenti dati del profilo oppure hai attivato un nuovo profilo e mancano i dati del profilo.	Le cause più comuni sono legate alla configurazione.	Consulta la sezione Risoluzione dei problemi.
Utilizzi uWSGI e non disponi di dati su tempo CPU e profilo di parete per tutte le procedure.	Quando uWSGI utilizza più worker per gestire le richieste, il valore predefinito è eseguire l'inizializzazione dell'applicazione solo il processo principale ("master"). I processi forcati non eseguono la sequenza di inizializzazione. Se configuri l'agente di profilazione nella sequenza di inizializzazione dell'applicazione, ad esempio in AppConfig.ready() in un'applicazione Django, l'effetto è che l'agente di profilazione non è configurato per i processi forkati.	Per eseguire l'inizializzazione dell'applicazione in tutti i processi di lavoro, imposta il flag lazy-apps su true. Per un problema correlato, consulta l'argomento successivo in questa tabella.
Utilizzi uWSGI e non disponi di dati del profilo di tempo di attesa, ma hai dati del profilo di tempo CPU.	Il profiler di Wall dipende dal modulo Python signal. Quando l'interprete Python viene compilato con il supporto dei thread, la configurazione predefinita disattiva la gestione degli indicatori personalizzati per i fork i processi di machine learning.	Per le applicazioni uWSGI, attiva la gestione personalizzata degli indicatori impostando il flag py-call-osafterfork su true. Consulta l'argomento precedente di questa tabella per un problema correlato.
Dopo aver attivato il profiler, il log degli errori contiene nuove voci: BlockingIOError: [Errno 11] Resource temporarily unavailable Exception ignored when trying to write to the signal wakeup fd Problema GitHub	La tua applicazione registrata con il descrittore file di riattivazione di Segnale, signal.set_wakeup_fd. Per impostazione predefinita, se il buffer del descrittore del file si riempie, viene visualizzato un avviso registrato in stderr. Quando Cloud Profiler raccoglie i profili, attiva gli indicatori con frequenza elevata. Questo comportamento può causare la presenza di un buffer del descrittore del file per riempirlo.	Se la tua applicazione può funzionare in sicurezza quando i segnali vengono persi, puoi utilizzare Cloud Profiler. Se utilizzi Python 3.7 o versioni successive e vuoi disattivare i messaggi di avviso, passa warn_on_full_buffer=False come parametro a signal.set_wakeup_fd. Se la tua applicazione non può essere eseguita in sicurezza quando gli indicatori vengono persi, ti consigliamo di interrompere l'utilizzo di Cloud Profiler. L'utilizzo continuato potrebbe causare la perdita di numeri di indicatori e voci eccessive nel log degli errori.

Esecuzione con Linux Alpine

Alpha

Questo prodotto o funzionalità è soggetto ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici del servizio. I prodotti e le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

L'agente di profilazione Python per Linux Alps è supportato solo per configurazioni di Google Kubernetes Engine.

Per creare l'agente di profilazione Python, devi installare il pacchetto build-base. Per utilizzare l'agente di profilazione Python su Alpine senza installare altri delle dipendenze all'immagine alpina finale, puoi usare una build in due fasi l'agente di profilazione Python nella prima fase. Ad esempio, la seguente immagine Docker utilizza una build a più fasi per compilare e installa l'agente di profilazione Python:

FROM python:3.7-alpine as builder

# Install build-base to allow for compilation of the profiling agent.
RUN apk add --update --no-cache build-base

# Compile the profiling agent, generating wheels for it.
RUN pip3 wheel --wheel-dir=/tmp/wheels google-cloud-profiler


FROM python:3.7-alpine

# Copy over the directory containing wheels for the profiling agent.
COPY --from=builder /tmp/wheels /tmp/wheels

# Install the profiling agent.
RUN pip3 install --no-index --find-links=/tmp/wheels google-cloud-profiler

# Install any other required modules or dependencies, and copy an app which
# enables the profiler as described in "Enable the profiler in your
# application".
COPY ./bench.py .

# Run the application when the docker image is run, using either CMD (as is done
# here) or ENTRYPOINT.
CMD python3 -u bench.py

Errore di autenticazione

Se utilizzi immagini Docker che vengono eseguite con Linux Alpine (ad esempio golang:alpine o solo alpine), potresti visualizzare il seguente errore di autenticazione:

connection error: desc = "transport: authentication handshake failed: x509: failed to load system roots and no roots provided"

Tieni presente che, per visualizzare l'errore, devi avere abilitato il logging dell'agente.

L'errore indica che le immagini Docker con Linux Alpine non hanno certificati SSL radice installati per impostazione predefinita. Questi certificati sono necessari per l'agente di profilazione per comunicare con l'API profiler. Da risolvere questo errore, aggiungi il seguente comando apk al tuo Dockerfile:

FROM alpine
...
RUN apk add --no-cache ca-certificates

Devi quindi ricreare la build ed eseguire nuovamente il deployment dell'applicazione.

Passaggi successivi

• Seleziona i profili da analizzare
• Interagire con il grafico a fiamme
• Filtrare il grafico a fiamme
• Mettere a fuoco il grafico a fiamme
• Confrontare i profili