Best practice per le richieste di assistenza Apigee di Google Cloud

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

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

Fornire informazioni dettagliate e richieste nella richiesta di assistenza semplifica il compito del team di assistenza Apigee di Google Cloud di rispondere in modo rapido ed efficiente. Quando nella tua richiesta di assistenza mancano dettagli importanti, dobbiamo chiederti ulteriori informazioni, il che potrebbe comportare scambi di email ripetuti. Questo richiede più tempo e può comportare ritardi nella risoluzione dei problemi. Questa guida alle best practice ti consente di conoscere le informazioni di cui abbiamo bisogno per risolvere più rapidamente la tua richiesta di assistenza tecnica.

Descrizione del problema

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

Informazioni chiave Descrizione Apigee Edge for Public Cloud Apigee Edge for Private Cloud
Prodotto Prodotto Apigee specifico in cui si verifica il problema, incluse le informazioni sulla versione, se applicabili.
  • Versione
Dettagli del problema Descrizione chiara e dettagliata del problema che lo illustra, incluso il messaggio di errore completo, se presente.
  • Messaggio di errore
  • Output dello strumento di traccia
  • Passaggi per riprodurre il problema
  • Richiesta/comando API completa
  • Messaggio di errore
  • Output dello strumento di traccia
  • Passaggi per riprodurre il problema
  • Richiesta/comando API completa
  • Log di diagnostica dei componenti
Ora Il timestamp specifico in cui è iniziato il problema e la 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 sul luogo in cui si verifica il problema.
  • Nome dell'organizzazione
  • Nome dell'ambiente
  • Nome del proxy API
  • Revisione
  • Topologia di rete
  • Componente Edge non funzionante

Le sezioni seguenti descrivono questi concetti in maggiore dettaglio.

Prodotto

Esistono diversi prodotti Apigee, Apigee Edge on Public Cloud e Apigee Edge on Private Cloud, pertanto abbiamo bisogno di informazioni specifiche su quale prodotto presenta il problema.

La tabella seguente fornisce alcuni esempi che mostrano informazioni complete nella colonna DA FARE e informazioni incomplete nella colonna DA NON FARE:

Azioni consigliate Azioni da evitare
Il deployment del proxy API OAuth2 non è riuscito nella nostra organizzazione Public Cloud ...

Deployment del proxy API non riuscito

(Dobbiamo sapere nel prodotto Apigee in cui si verifica il problema).

L'installazione non è riuscita con il seguente errore sul nostro Edge Private Cloud versione 4.50.00 ...

L'installazione non è riuscita nella configurazione del nostro Private Cloud.

(Informazioni sulla versione mancanti)

Dettagli del problema

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

La tabella seguente fornisce alcuni esempi che mostrano informazioni complete nella colonna DA FARE e informazioni incomplete nella colonna DA NON FARE:

Azioni consigliate Azioni da evitare

Il nuovo proxy edgemicro edgemicro_auth non funziona a causa del 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 restituisce un errore o una risposta imprevista.

I nostri clienti 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 clienti ricevono errori 500 durante l'invio di richieste all'API proxy.

(La semplice comunicazione di errori 500 non fornisce informazioni adeguate per consentirci di esaminare il problema. Abbiamo bisogno di conoscere il messaggio di errore e il codice di errore effettivi rilevati.

Ora

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

Il tecnico dell'assistenza che risolve il problema potrebbe non trovarsi nel tuo fuso orario, pertanto le dichiarazioni relative al tempo rendono più difficile la diagnosi del problema. Pertanto, è consigliabile utilizzare il formato ISO 8601 per la data e l'ora del timestamp per fornire le informazioni sull'ora esatta in cui è stato rilevato il problema.

La tabella seguente fornisce alcuni esempi che mostrano l'ora e la durata esatti in cui si è verificato il problema nella colonna DA FARE e informazioni ambigue o poco chiare su quando si è verificato il problema nella colonna DA NON FARE:

Azioni consigliate Azioni da evitare
Ieri è stato osservato un numero enorme di 503s tra le 17:30 PDT del 06/11/2020 e le 17:35 PDT del 06/11/2020...

Ieri alle 17:30 sono stati osservati un numero enorme di 503s per 5 minuti.

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

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

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

Non è chiaro quale giorno e per quale durata questo problema è stato osservato nell'ultima settimana.

Configurazione

Abbiamo bisogno di conoscere i dettagli su dove esattamente si verifica 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 conoscere l'organizzazione specifica e altri dettagli in cui riscontri il problema:
    • Nomi dell'organizzazione e dell'ambiente
    • Nome e numeri di revisione del proxy API (per i fallimenti delle richieste API)
  • Se utilizzi Private Cloud , potresti utilizzare una delle molte topologie di installazione supportate. Dobbiamo quindi sapere quale topologia utilizzi, inclusi i dettagli come il numero di data center e nodi.

La tabella seguente fornisce alcuni esempi che mostrano informazioni complete nella colonna DA FARE e informazioni incomplete nella colonna DA NON FARE:

Azioni consigliate Azioni da evitare

401 Gli errori sono aumentati su Edge Public Cloud dal giorno 06-11-2020 09:30 CST.

Dettagli sulla configurazione di Edge:

I dettagli dell'API con errori sono i seguenti:
  Nomi org: myorg
  Nomi env: 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 Gli errori sono aumentati.

Non fornisce alcuna informazione sul prodotto in uso, dal momento in cui viene rilevato il problema o su eventuali dettagli di configurazione.

Impossibile avviare il Message Processor su Edge Private Cloud versione 4.19.06 dopo aver aggiunto altri nodi gateway.

Log di diagnostica:
Ho allegato i log del Message Processor.

Topologia di rete:
È stato allegato il file network-topology.png contenente i nodi aggiuntivi.

Impossibile avviare il Message Processor su Edge Private Cloud versione 4.19.06 dopo aver aggiunto altri nodi gateway.

(I log del Message Processor e la topologia di rete non sono presenti).

Artefatti utili

Forniscici gli elementi correlati al problema per velocizzare la risoluzione, in quanto ci aiutano a comprendere il comportamento esatto che stai osservando e a ottenere ulteriori informazioni in merito.

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

Elementi comuni per tutti i prodotti Apigee

I seguenti elementi sono utili per tutti i prodotti Apigee: Apigee Edge su Public Cloud e Apigee Edge su Private Cloud:

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

Elementi aggiuntivi per Apigee Edge per il cloud privato

Per Apigee Edge for Private Cloud, potremmo aver bisogno di alcuni elementi aggiuntivi che faciliteranno una diagnosi più rapida dei problemi.

Artefatto Descrizione
Topologia di rete Il diagramma della topologia di installazione di Edge che descrive la configurazione del tuo cloud privato, inclusi tutti i data center, i nodi e i componenti installati in ogni nodo.
Log di diagnostica dei componenti Edge I log di diagnostica relativi al componente Apigee Edge specifico, ad esempio Message Processor, Router o Cassandra.
File di configurazione dell'installazione Il file di configurazione silenzioso utilizzato durante l'installazione o l'upgrade di Apigee Edge.

Questo file è utile per verificare se tutte le impostazioni sono corrette 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 si verificano errori OutOfMemory o un utilizzo elevato della memoria su determinati componenti di Edge.
Dump dei thread Un dump del thread è uno snapshot di tutti i thread di un processo Java in esecuzione.

Questa opzione è utile se viene rilevato un carico o una CPU elevati su determinati componenti Edge.

Modelli di richieste e richieste di esempio

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

Apigee Edge su cloud pubblico

Modello

Questa sezione fornisce un modello di esempio per Apigee Edge su Public Cloud.

Problema:

<Fornisci una descrizione dettagliata del problema o del comportamento osservato. Includi il nome e la versione del prodotto, se applicabile.>

Messaggio di errore:

<Include the complete error message observed (if any)>

Ora di inizio del problema (formato ISO 8601):

Ora di fine del problema (formato ISO 8601):

Dettagli di configurazione di Apigee:
  Nomi delle organizzazioni:
  Nomi degli ambienti:
  Nomi dei proxy API:
  Numeri di revisione:

Passaggi per la riproduzione del problema:

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

Informazioni di diagnostica:

<List of files attached>

Caso di esempio

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

Problema:

Stiamo riscontrando un numero elevato di errori 503 (Servizio non disponibile) nella nostra organizzazione Public Cloud. Puoi esaminare il problema e risolverlo o consigliarci come farlo?

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): 04-10-2020 06:30 IST

Ora di fine del problema (formato ISO 8601): il problema persiste.

Dettagli di configurazione di Apigee Cloud:
  Nomi delle organizzazioni: myorg
  Nomi degli ambienti: dev
  Nomi dei proxy API: myproxy
  Numeri di revisione: 3

Passaggi per la riproduzione del problema:

Esegui il seguente comando curl per riprodurre il problema:

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

Informazioni di diagnostica:

Output dello strumento di traccia (trace-503.xml)

Apigee Edge for Private Cloud

Modello

Questa sezione fornisce un modello di esempio per Apigee Edge for Private Cloud.

Problema:

<Fornisci una descrizione dettagliata del problema o del comportamento osservato. Includi il nome e la versione del prodotto, se applicabile.>

Messaggio di errore:

<Include the complete error message observed (if any)>

Ora di inizio del problema (formato ISO 8601):

Ora di fine del problema (formato ISO 8601):

Dettagli sulla 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 del problema:

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

Informazioni di diagnostica

<List of files attached>

Caso di esempio

Questa sezione fornisce un caso d'uso di esempio per Apigee Edge for Private Cloud.

Problema:

Durante l'installazione di Apigee Management Server sul nodo 10 nell'ambito 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 sulla configurazione di Edge Private Cloud:

Ho allegato il file network-topology.png

Passaggi per la riproduzione del problema:

Ecco il comando che ha generato l'errore riportato sopra:

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

Informazioni di diagnostica:

Sono stati allegati i seguenti file:

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