Utilizzo del raccoglitore Diagnostic

Al momento stai visualizzando la versione 1.7 della documentazione di Apigee hybrid. This version is end of life. You should upgrade to a newer version. Per ulteriori informazioni, consulta Versioni supportate.

Version 1.7 (unsupported)

   Versioni supportate:

• v1.13 (più recente)                        
• v1.12                         
• v1.11                         
• Elenco delle versioni supportate

Versioni non supportate:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Il Collector diagnostico è uno strumento che acquisisce i dati di diagnostica sui componenti Kubernetes di un'istanza Apigee ibrida on demand e li archivia nei bucket Google Cloud Storage. Invochi il raccoglitore di diagnostica con il comando apigeectl diagnostic.

Quali dati di sistema vengono acquisiti?

Il raccoglitore di diagnostica acquisisce i seguenti tipi di dati:

• Modifica dei livelli di log.
• Jstack.
• File YAML di configurazione del POD.
• Output PS -ef.
• dump TCP.
• Output TOP.

Che cosa succede ai dati?

Quando il raccoglitore di diagnostica acquisisce i dati, questi vengono caricati in un bucket di archiviazione progetto Google Cloud. Puoi visualizzare i dati archiviati nel browser Google Cloud: Cloud Storage.

Se vuoi, puoi scegliere di condividere questi dati con l'assistenza di Google Apigee quando crei un ticket di assistenza.

Nota: i dati di runtime o le informazioni sensibili non vengono acquisiti nel dati raccolti dal raccoglitore di diagnostica.

Prerequisiti per l'esecuzione del raccoglitore Diagnostic

Prima di utilizzare il raccoglitore diagnostico, devi completare i seguenti prerequisiti:

Bucket Google Cloud Storage

Crea un bucket Google Cloud Storage con un nome univoco nel tuo progetto Google Cloud. Puoi crea e gestisci i bucket con i comandi gcloud storage o nel Google Cloud Piattaforma: browser Cloud Storage.

Ad esempio:

gcloud storage buckets create gs://apigee_diagnostic_data

Creating gs://apigee_diagnostic_data/...

I nomi dei bucket devono essere univoci a livello globale in tutti i progetti Google Cloud, incluse quelle esterne alla tua organizzazione.

Per le istruzioni, consulta la sezione Creazione di bucket di archiviazione.

Service account

Crea un account di servizio con il ruolo Amministratore di archiviazione (roles/storage.admin) nel tuo progetto e scarica il file della chiave .json dell'account di servizio.

L'account di servizio può avere un nome univoco qualsiasi. Questa guida utilizza "apigee-diagnostic" per il nome dell'account di servizio.

Ad esempio:

gcloud config set project ${PROJECT_ID}

gcloud iam service-accounts create apigee-diagnostic

gcloud projects add-iam-policy-binding ${PROJECT_ID} \
    --member="serviceAccount:apigee-diagnostic@${PROJECT_ID}.iam.gserviceaccount.com" \
    --role="roles/storage.admin"

gcloud iam service-accounts keys create ${PROJECT_ID}-apigee-diagnostic.json \
    --iam-account=apigee-diagnostic@${PROJECT_ID}.iam.gserviceaccount.com

Vedi:

• Creazione e gestione del servizio Google Cloud.
• Creazione e gestione delle chiavi degli account di servizio.
• Comprensione dei ruoli: cloud Ruoli di archiviazione.

Utilizzo del raccoglitore Diagnostic

La sequenza per utilizzare il raccoglitore di diagnostica è:

1. Configura la stanza diagnostica nel file overrides.yaml per selezionare il tipo di informazioni, il container Apigee e i singoli pod da cui vuoi ricevere i dati diagnostici. Consulta: Configurazione di overrides.yaml per il raccoglitore di diagnostica.
2. Esegui il Collector diagnostico con il seguente comando apigeectl.

   apigeectl diagnostic -f OVERRIDES_FILE

   dove OVERRIDES_FILE è il percorso del file overrides.yaml.

3. Controlla i log:
   1. Recupera i pod nello spazio dei nomi apigee-diagnostic.

      kubectl get pods -n apigee-diagnostic

   2. Prendi nota del pod con il nome che contiene diagnostic-collector
   3. Controlla i log con il seguente comando:

      kubectl -n apigee-diagnostic logs -f POD_NAME

      Dove POD_NAME è il nome del pod del raccoglitore Diagnostic.

      Puoi anche visualizzare i log raccolti nel browser Google Cloud: Cloud Storage.

4. Dopo aver raccolto i dati, elimina il raccoglitore diagnostico. Non puoi eseguirlo di nuovo fino a quando non lo avrai eliminato.

   apigeectl diagnostic delete -f OVERRIDES_FILE

Configurazione di overrides.yaml per il raccoglitore Diagnostic

Prima di poter eseguire il Collector diagnostico, devi configurarlo nel file overrides.yaml.

Per un riferimento completo delle proprietà di configurazione diagnostic, consulta il riferimento per le proprietà di configurazione: diagnostic.

Proprietà obbligatorie

Le seguenti proprietà sono obbligatorie per l'esecuzione del Collector diagnostico.

• diagnostic.serviceAccountPath: il percorso di un file della chiave dell'account di servizio per l'account di servizio con il ruolo Amministratore archiviazione in Prerequisiti.
• diagnostic.operation: specifica se raccogliere tutte le statistiche o solo i log.

  I valori sono: "ALL" o "LOGGING"

  Se imposti diagnostic.operation su "LOGGING", verrà applicata la seguente sono obbligatorie:

  • diagnostic.loggingDetails.logDuration
  • diagnostic.loggingDetails.loggerNames
  • diagnostic.loggingDetails.logLevel
• diagnostic.bucket: il nome del bucket Google Cloud Storage in cui verranno depositati i dati diagnostici. Questo è il bucket che hai creato in Prerequisiti.
• diagnostic.container: specifica il tipo di pod in cui stai acquisendo i dati da cui proviene. I valori possono essere:

  Valore container	Componente Apigee	Spazio dei nomi Kubernetes	Nome del pod di esempio in questo container
  apigee-cassandra	Cassandra	apigee	apigee-cassandra-default-0
  istio-proxy	Ingress Istio	istio-system	istio-ingressgateway-696879cdf8-9zzzf
  apigee-mart-server	MART	apigee	apigee-mart-hybrid-example-d89fed1-151-jj2ux-l7nlb
  apigee-runtime	processore di messaggi	apigee	apigee-runtime-hybrid-example-3b2ebf3-151-s64bh-g9qmv
  apigee-synchronizer	Sincronizzatore	apigee	apigee-synchronizer-hybrid-example-3b2ebf3-151-xx4z6cg78
  apigee-udca	UDCA	apigee	apigee-udca-hybrid-example-3b2ebf3-151-q4g2c-vnzg9
  apigee-watcher	Watcher	apigee	apigee-watcher-hybrid-example-d89fed1-151-cpu3s-sxxdf

• diagnostic.namespace: lo spazio dei nomi Kubernetes in cui si trovano i pod raccolgono dati in tempo reale. Lo spazio dei nomi deve essere corretto per il container specificato con diagnostic.container.
• diagnostic.podNames: i nomi dei singoli pod su cui vuoi raccogliere i dati di diagnostica. Ad esempio:

  diagnostic:
   …
   podNames:
   - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
   - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2

Proprietà obbligatorie solo quando l'operazione è impostata su LOGGING

Le seguenti proprietà sono obbligatorie solo quando è in esecuzione il raccoglitore diagnostico con diagnostic.operation è LOGGING.

• diagnostic.loggerNames: specifica per nome i logger da cui raccogliere i dati. Per la versione 1.6.0 di Apigee hybrid, l'unico valore supportato è ALL, ovvero tutti i logger. Ad esempio:

  diagnostic:
   …
   loggingDetails:
     loggerNames:
     - ALL

• diagnostic.logLevel: specifica la granularità dei dati di log da raccogliere. In Apigee hybrid 1.6, è supportato solo FINE.
• diagnostic.logDuration: la durata in millisecondi dei dati di log raccolti. R il valore tipico è 30000.

Proprietà facoltative

Le seguenti proprietà sono facoltative.

• diagnostic.tcpDumpDetails.maxMsgs: imposta il numero massimo di tcpDump messaggi da raccogliere. Apigee consiglia un valore massimo non superiore a 1000.
• diagnostic.tcpDumpDetails.timeoutInSeconds: imposta la quantità di tempo in secondi per attendi che tcpDump restituisca i messaggi.
• diagnostic.threadDumpDetails.delayInSeconds: il ritardo in secondi tra raccogliendo ogni dump dei thread. Da utilizzare con diagnostic.threadDumpDetails.iterations.
• diagnostic.threadDumpDetails.iterations: il numero di iterazioni del dump del thread jstack da raccogliere. Da utilizzare con diagnostic.threadDumpDetails.delayInSeconds.

Esempio generale

Di seguito è riportato un esempio di stanza diagnostic che mostra tutte le voci possibili:

diagnostic:
  # required properties:
  serviceAccountPath: "service-accounts/apigee-diagnostics.json"
  operation: "ALL"
  bucket: "diagnostics_data"
  container: "apigee-runtime"
  namespace: "apigee"
  podNames:
  - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
  - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2

  # required if operation is Logging
  loggingDetails:
    loggerNames:
    - ALL
    logLevel: FINE
    logDuration: 30000

  # optional properties:
  tcpDumpDetails:
    maxMsgs: 10
    timeoutInSeconds: 100

  threadDumpDetails:
    iterations: 5
    delayInSeconds: 2

Casi d'uso comuni

I seguenti esempi mostrano come configurare e utilizzare il raccoglitore diagnostico in alcune situazioni comuni.

Latenza proxy elevata

In questo caso, Apigee-runtime impiega molto tempo per elaborare le richieste, causando latenze elevate dei proxy per i clienti. Devi raccogliere l'output Jstack e TOP.

1. Seleziona due pod del runtime.
2. Crea la stanza diagnostic con la seguente struttura:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "ALL"
     bucket: "diagnostics_data"
     container: "apigee-runtime"
     namespace: "apigee"
     podNames:
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
   
     tcpDumpDetails:
       maxMsgs: 10
   
     threadDumpDetails:
       iterations: 15
       delayInSeconds: 1

3. Dopo aver configurato la stanza diagnostic, esegui il raccoglitore Diagnostic.

   apigeectl diagnostic -f OVERRIDES_FILE

4. Raccogli i log ed elimina il raccoglitore diagnostico.

   apigeectl diagnostic delete -f OVERRIDES_FILE

Problemi di rete / connettività

Devi eseguire la diagnostica su apigee-runtime e pod del gateway in entrata.

1. Seleziona due pod del runtime.
2. Crea la stanza diagnostic con la seguente struttura:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "ALL"
     bucket: "diagnostics_data"
     container: "apigee-runtime"
     namespace: "apigee"
     podNames:
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
   
     tcpDumpDetails:
       maxMsgs: 1000

3. Dopo aver configurato la stanza diagnostic, esegui il raccoglitore Diagnostic.

   apigeectl diagnostic -f OVERRIDES_FILE

4. Raccogli i log ed elimina il raccoglitore Diagnostic.

   apigeectl diagnostic delete -f OVERRIDES_FILE

5. Seleziona due pod dal gateway di ingresso Istio.
6. Riconfigura la stanza diagnostic con i pod di ingresso Istio:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "ALL"
     bucket: "diagnostics_data"
     container: "istio-proxy"
     namespace: "istio-system"
     podNames:
     - istio-ingressgateway-696879cdf8-9zzzf
     - istio-ingressgateway-696879cdf8-6abc7
   
     tcpDumpDetails:
       maxMsgs: 1000

7. Dopo aver configurato la stanza diagnostic, esegui il raccoglitore Diagnostic.

   apigeectl diagnostic -f OVERRIDES_FILE

8. Raccogli i log ed elimina il raccoglitore Diagnostic.

   apigeectl diagnostic delete -f OVERRIDES_FILE

I proxy generano errori imprevisti o non vengono applicati nuovi contratti

In questo caso, devi modificare i livelli di log per il debug per almeno 5 minuti o anche 10 minuti come in questo esempio. In questo modo aumenterà la quantità di log, ma verranno registrate informazioni utili. Eseguirai il raccoglitore diagnostico due volte, una sul runtime Apigee e poi sul sincronizzatore Apigee.

1. Seleziona due pod del runtime.
2. Crea la stanza diagnostic con la seguente struttura:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "LOGGING"
     bucket: "diagnostics_data"
     namespace: "apigee"
     container: "apigee-runtime"
     podNames:
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
   
     loggingDetails:
       loggerNames:
       - ALL
       logLevel: FINE
       logDuration: 60000

3. Dopo aver configurato la stanza diagnostic, esegui il raccoglitore Diagnostic.

   apigeectl diagnostic -f OVERRIDES_FILE

4. Raccogli i log ed elimina il raccoglitore diagnostico.

   apigeectl diagnostic delete -f OVERRIDES_FILE

5. Seleziona due pod di sincronizzazione.
6. Crea la stanza diagnostic con la seguente struttura:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "LOGGING"
     bucket: "diagnostics_data"
     namespace: "apigee"
     container: "apigee-synchronizer"
     podNames:
     - apigee-synchronizer-hybrid-example-3b2ebf3-150-xx4z-6cg78
     - apigee-synchronizer-hybrid-example-3b2ebf3-150-xx4z-1a2b3
   
     loggingDetails:
       loggerNames:
       - ALL
       logLevel: FINE
       logDuration: 60000

7. Dopo aver configurato la stanza diagnostic, esegui il raccoglitore Diagnostic.

   apigeectl diagnostic -f OVERRIDES_FILE

8. Raccogli i log ed elimina il raccoglitore Diagnostic.

   apigeectl diagnostic delete -f OVERRIDES_FILE