Best practice per le richieste di assistenza Apigee di Google Cloud

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Stai visualizzando la documentazione di Apigee X.
Visualizza la documentazione di Apigee Edge.

Fornire informazioni dettagliate e richieste nella richiesta di assistenza consente al team di assistenza Apigee di Google Cloud di risponderti in modo più semplice ed efficiente. Se nella tua richiesta di assistenza mancano dettagli critici, abbiamo bisogno di ulteriori informazioni, il che potrebbe comportare un processo continuo e ripetuto più volte. Questa operazione richiede più tempo e può comportare ritardi nella risoluzione dei problemi. Questa guida alle best practice fornisce le informazioni necessarie per risolvere più rapidamente la richiesta di assistenza tecnica.

Descrizione del problema

Un problema deve contenere informazioni che spieghino i dettagli di ciò che è accaduto rispetto a ciò che si sarebbe verificato, nonché di quando e come è successo. Una richiesta di assistenza Apigee valida deve contenere le seguenti informazioni chiave per ciascuno dei prodotti Apigee:

Informazioni chiave Descrizione Apigee Edge per il cloud pubblico Apigee Edge for Private Cloud
Prodotto Prodotto specifico di Apigee in cui si verifica il problema, incluse informazioni sulla versione ove applicabili.
  • Versione
Dettagli del problema Una descrizione chiara e dettagliata del problema che descrive il problema, incluso l'eventuale messaggio di errore completo.
  • Messaggio di errore
  • Output dello strumento Trace
  • Passaggi per riprodurre il problema
  • Comando/richiesta API completa
  • Messaggio di errore
  • Output dello strumento Trace
  • Passaggi per riprodurre il problema
  • Comando/richiesta API completa
  • Log di diagnostica dei componenti
Tempo Il timestamp specifico del momento in cui si è verificato il problema e della relativa durata.
  • Data, ora e fuso orario in cui si è verificato il problema
  • Durata del problema
  • Data, ora e fuso orario in cui si è verificato il problema
  • Durata del problema
Configurazione Informazioni dettagliate su dove si verifica il problema.
  • Nome organizzazione
  • Nome ambiente
  • Nome proxy API
  • Revisione
  • Topologia di rete
  • Componente Failing Edge

Le sezioni seguenti descrivono questi concetti in modo più dettagliato.

Prodotto

Esistono diversi prodotti Apigee, Apigee Edge su cloud pubblico e Apigee Edge su cloud privato, pertanto abbiamo bisogno di informazioni specifiche sul prodotto specifico che presenta il problema.

La seguente tabella fornisce alcuni esempi che mostrano informazioni complete nella colonna Cose da fare e informazioni incomplete nella colonna Cose da fare:

cose da fare Azioni sconsigliate
Deployment del proxy API OAuth2 non riuscito nell'organizzazione Public Cloud ...

Deployment del proxy API non riuscito

(Dobbiamo conoscere il prodotto Apigee in cui riscontri il problema).

Installazione non riuscita con il seguente errore nel nostro Edge Private Cloud versione 4.50.00 ...

Installazione non riuscita nella configurazione del nostro Private Cloud.

(Informazioni sulla versione mancanti)

Dettagli del problema

Fornisci informazioni precise sul problema osservato, inclusi il messaggio di errore (se presente) e il comportamento previsto ed effettivo osservato.

La seguente tabella fornisce alcuni esempi che mostrano informazioni complete nella colonna Cose da fare e informazioni incomplete nella colonna Cose da fare:

cose da fare Azioni sconsigliate

Il nuovo proxy edgemicro edgemicro_auth non funziona con il seguente errore:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

Il nuovo proxy edgemicro creato oggi non funziona

Il nome del proxy è sconosciuto. Non è chiaro se il proxy stia restituendo un errore o qualsiasi risposta imprevista.)

I nostri client ricevono errori 500 con il seguente messaggio di errore durante l'invio di richieste al proxy API:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

I nostri client ricevono 500 errori durante l'invio di richieste al proxy API.

(La sola comunicazione di 500 errori non ci fornisce informazioni sufficienti per consentirci di effettuare accertamenti in merito al problema. dobbiamo conoscere il messaggio e il codice di errore effettivi osservati.)

Ora

Il tempo è un'informazione molto importante. È importante che il tecnico dell'assistenza sappia quando hai notato il problema per la prima volta, quanto è durato e se il problema persiste.

L'esperto di assistenza che risolve il problema potrebbe non trovarsi nel tuo fuso orario, quindi affermazioni relative all'ora rendono il problema più difficile da diagnosticare. Di conseguenza, ti consigliamo di utilizzare il formato ISO 8601 per il timestamp di data e ora, in modo da fornire informazioni precise sull'ora in cui si è verificato il problema.

La seguente tabella fornisce alcuni esempi che mostrano l'ora e la durata precise per cui si è verificato il problema nella colonna Azioni e informazioni ambigue o non chiare relative a quando si è verificato il problema nella colonna Azioni consigliate:

cose da fare Azioni sconsigliate
Ieri è stato osservato un numero enorme di 503s tra il 6/11/2020 17:30 PDT e il 6/11/2020 17:35 PDT...

Un numero enorme di 503s è stato osservato ieri alle 17:30 per 5 minuti.

Siamo costretti a utilizzare la data implicita e non è chiaro nemmeno in quale fuso orario è stato riscontrato il problema.

Sono state osservate latenze elevate sui seguenti proxy API dalle ore 2020-11-09 15:30 IST al 2020-11-09 18:10 IST ...

La scorsa settimana sono state osservate latenze elevate su alcuni proxy API.

Non è chiaro il giorno e la durata in cui il problema si è verificato nell'ultima settimana.

Configurazione

Dobbiamo conoscere i dettagli relativi al punto esatto in cui riscontri il problema. A seconda del prodotto che utilizzi, abbiamo bisogno delle seguenti informazioni:

  • Se utilizzi Apigee Cloud, potresti avere più di un'organizzazione, quindi dobbiamo conoscerne l'organizzazione specifica e altri dettagli su cui stai osservando il problema:
    • Nomi di organizzazioni e ambienti
    • Nome proxy API e numeri di revisione (per errori di richieste API)
  • Se utilizzi Private Cloud , è possibile che tu stia utilizzando una delle numerose topologie di installazione supportate. Quindi, dobbiamo sapere quale topologia stai utilizzando, compresi dettagli come il numero di data center e nodi.

La seguente tabella fornisce alcuni esempi che mostrano informazioni complete nella colonna Cose da fare e informazioni incomplete nella colonna Cose da fare:

cose da fare Azioni sconsigliate

401 Gli errori sono aumentati su Edge Public Cloud dal 6/11/2020 09:30 CST.

Dettagli di configurazione Edge:

I dettagli dell'API in errore sono i seguenti:
Nomi delle organizzazioni: myorg
Nomi di ambiente: test
Nomi proxy API: myproxy
Numeri di revisione: 3

Errore:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

401 errori sono aumentati.

Non fornisce alcuna informazione sul prodotto utilizzato, dal momento in cui il problema viene osservato, né eventuali dettagli di configurazione.

Impossibile avviare il processore di messaggi su Edge Private Cloud versione 4.19.06 , dopo l'aggiunta di altri nodi gateway.

Log della diagnostica:
Sono stati allegati i log del processore di messaggi.

Topologia di rete:
è stato allegato il file network-topology.png che contiene i nodi aggiuntivi.

Impossibile avviare il processore di messaggi su Edge Private Cloud versione 4.19.06 , dopo l'aggiunta di altri nodi gateway.

Mancano i log del processore di messaggi e la topologia di rete.

Artefatti utili

Fornendoci elementi relativi al problema, velocizzi la risoluzione, in quanto ci aiuta a comprendere il comportamento esatto che stai osservando e a ottenere più informazioni a riguardo.

Questa sezione descrive alcuni artefatti utili per tutti i prodotti Apigee:

Artefatti comuni per tutti i prodotti Apigee

I seguenti artefatti sono utili per tutti i prodotti Apigee: Apigee Edge su cloud pubblico e Apigee Edge su cloud privato:

Artefatto Descrizione
Output dello strumento Traccia L'output dello strumento Trace contiene informazioni dettagliate sulle richieste API che passano attraverso i prodotti Apigee. Questa soluzione è utile per qualsiasi errore di runtime come 4XX, 5XX e per problemi di latenza.
Screenshot Gli screenshot aiutano a comunicare il contesto del comportamento o dell'errore effettivamente osservato. È utile per eventuali errori o problemi osservati, ad esempio nell'interfaccia utente o in Analytics.
HAR (ARchive HTTP) HAR è un file acquisito dagli strumenti della sessione HTTP per eseguire il debug di eventuali problemi relativi all'interfaccia utente. Questi dati possono essere acquisiti utilizzando browser come Chrome, Firefox o Internet Explorer.
tcpdumps Lo strumento tcpdump acquisisce i pacchetti TCP/IP trasferiti o ricevuti sulla rete. Ciò è utile per qualsiasi problema relativo alla rete, come errori di handshake TLS, errori 502, problemi di latenza e così via.

Artefatti aggiuntivi per Apigee Edge per il cloud privato

Per Apigee Edge per il cloud privato, potremmo aver bisogno di alcuni artefatti aggiuntivi che faciliteranno una diagnosi più rapida dei problemi.

Artefatto Descrizione
Topologia di rete Diagramma della topologia dell'installazione perimetrale che descrive la configurazione del cloud privato, inclusi tutti i data center, i nodi e i componenti installati in ciascun nodo.
Log di diagnostica dei componenti Edge I log di diagnostica relativi allo specifico componente Apigee Edge come processore di messaggi, router o Cassandra.
File di configurazione dell'installazione Il file di configurazione invisibile che viene utilizzato durante l'installazione o l'upgrade di Apigee Edge.

Questo file è utile per verificare la correttezza di tutte le impostazioni nei casi in cui si verifichino problemi di installazione o migrazione.

Dump dell'heap I dump dell'heap sono uno snapshot del processo di memoria Java. Questa operazione è utile se su determinati componenti Edge vengono rilevati errori OutOfMemory o un utilizzo elevato della memoria.
Thread dump Un thread dump è uno snapshot di tutti i thread di un processo Java in esecuzione.

Questa operazione è utile in caso di CPU o carico elevato su alcuni componenti Edge.

Modelli di casi e casi di esempio

Questa sezione fornisce modelli di richieste e casi di esempio per prodotti diversi in base alle best practice descritte in questo documento:

Apigee Edge sul cloud pubblico

Modello

Questa sezione fornisce un modello di esempio per Apigee Edge su cloud pubblico.

Problema:

<Fornisci una descrizione dettagliata del problema o del comportamento osservato da te. Se possibile, includi il nome del prodotto e la versione.>

Messaggio di errore:

<Includi il messaggio di errore completo osservato (se presente)>

Ora di inizio del problema (formato ISO 8601):

Ora di fine del problema (formato ISO 8601):

Dettagli di configurazione di Apigee:
Nomi organizzazioni:
Nomi di ambiente:
Nomi proxy API:
Numeri di revisione:

Passaggi per la riproduzione:

<Fornisci i passaggi per riprodurre il problema, ove possibile>

Informazioni diagnostiche:

<Elenco dei file allegati>

Caso di esempio

Questa sezione fornisce un caso di esempio per Apigee Cloud (Apigee su Google Cloud/Apigee Edge su cloud pubblico).

Problema:

Stiamo riscontrando un numero elevato di errori di servizio 503 non disponibile nella nostra organizzazione Cloud pubblico. Puoi esaminare il problema e risolverlo o indicarci come risolverlo?

Messaggio di errore:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

Ora di inizio del problema (formato ISO 8601): 2020-10-04 06:30 IST

Ora di fine del problema (formato ISO 8601): il problema è ancora presente.

Dettagli di configurazione di Apigee Cloud:
Nomi organizzazioni: myorg
Nomi di ambiente: dev
Nomi proxy API: myproxy
Numeri di revisione: 3

Passaggi per la riproduzione:

Esegui questo comando curl per riprodurre il problema:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

Informazioni diagnostiche:

Output dello strumento Trace (trace-503.xml)

Apigee Edge for Private Cloud

Modello

Questa sezione fornisce un modello di esempio per Apigee Edge per il cloud privato.

Problema:

<Fornisci una descrizione dettagliata del problema o del comportamento osservato da te. Se possibile, includi il nome del prodotto e la versione.>

Messaggio di errore:

<Includi il messaggio di errore completo osservato (se presente)>

Ora di inizio del problema (formato ISO 8601):

Ora di fine del problema (formato ISO 8601):

Dettagli di configurazione di Edge Private Cloud:

<Allega la topologia di rete che descrive la configurazione del tuo cloud privato, inclusi data center e nodi>

Passaggi per la riproduzione:

<Fornisci i passaggi per riprodurre il problema, ove possibile>

Informazioni diagnostiche

<Elenco dei file allegati>

Caso di esempio

Questa sezione fornisce un caso di esempio per Apigee Edge per il cloud privato.

Problema:

Durante l'installazione del server di gestione Apigee sul nodo 10 come parte di Edge Private Cloud 4.19.06 su Linux RHEL 7.6, abbiamo riscontrato il seguente errore.

Messaggio di errore:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

Ora di inizio del problema (formato ISO 8601): si verifica ogni volta che installiamo

Ora di fine del problema (formato ISO 8601): non applicabile

Dettagli di configurazione di Edge Private Cloud:

Allegato il file network-topology.png

Passaggi per la riproduzione:

Di seguito è riportato il comando che ha generato l'errore indicato in precedenza:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

Informazioni diagnostiche:

Abbiamo allegato i seguenti file:

  • output.txt contenenti l'output completo del comando riportato sopra, incluso il messaggio di errore
  • Log del server di gestione e
  • File di configurazione NonProdConfig.txt