Best practice per le richieste di assistenza Apigee di Google Cloud

Stai visualizzando la documentazione di Apigee Edge.
Consulta la 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 rende più semplice per il team di assistenza Google Cloud Apigee risponderti in modo rapido ed efficiente. Quando nella richiesta di assistenza mancano dettagli fondamentali, dobbiamo chiedere ulteriori informazioni, il che potrebbe comportare diversi scambi di messaggi. Questa operazione richiede più tempo e può comportare ritardi nella risoluzione dei problemi. Questa guida alle best practice ti indica 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 di ciò che è successo rispetto a ciò che era previsto, nonché quando e come è successo. 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 viene osservato il problema, incluse le informazioni sulla versione, se applicabile.
  • Versione
Dettagli del problema Descrizione chiara e dettagliata del problema che ne illustri la natura, incluso il messaggio di errore completo, se presente.
  • Messaggio di errore
  • Output dello strumento di tracciamento
  • Passaggi per riprodurre il problema
  • Richiesta/comando API completo
  • Messaggio di errore
  • Output dello strumento di tracciamento
  • Passaggi per riprodurre il problema
  • Richiesta/comando API completo
  • Log di diagnostica dei componenti
Ora Il timestamp specifico in cui è iniziato il problema e la sua 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 viene osservato il problema.
  • Nome dell'organizzazione
  • Nome ambiente
  • Nome del proxy API
  • Revisione
  • Topologia di rete
  • Componente Edge non conforme

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

Prodotto

Esistono diversi prodotti Apigee, Apigee Edge su Public Cloud e Apigee Edge su Private Cloud, quindi abbiamo bisogno di informazioni specifiche sul prodotto in particolare che presenta il problema.

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

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

Il deployment del proxy API non è riuscito

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

L'installazione non è riuscita con il seguente errore nella nostra versione 4.50.00 di Edge Private Cloud…

L'installazione non è riuscita durante la configurazione del cloud privato.

(Mancano le informazioni sulla versione)

Dettagli del problema

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

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

Azioni consigliate Azioni da evitare

Il nuovo proxy edgemicro edgemicro_auth non funziona e restituisce 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 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 al proxy API.

(La semplice comunicazione di 500 errori non fornisce informazioni sufficienti per consentirci di analizzare il problema. Dobbiamo conoscere il messaggio di errore e il codice di errore effettivi che vengono osservati.)

Ora

Il tempo è un'informazione molto importante. È importante che l'ingegnere dell'assistenza sappia quando hai notato per la prima volta questo problema, quanto è durato e se è ancora in corso.

Il tecnico del servizio di assistenza che si occupa del problema potrebbe non trovarsi nel tuo fuso orario, per cui affermazioni relative riguardo all'ora rendono più difficile la diagnosi del problema. Pertanto, è consigliabile utilizzare il formato ISO 8601 per il timestamp di data e ora per fornire informazioni precise sull'ora in cui è stato osservato il problema.

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

Azioni consigliate Azioni da evitare
Ieri è stato osservato un numero elevato di 503s tra le ore 17:30 PDT del 6 novembre 2020 e le ore 17:35 PDT del 6 novembre 2020...

Ieri alle 17:30 è stato osservato un numero elevatissimo di 503s per 5 minuti.

(Siamo costretti a utilizzare la data implicita e non è chiaro in quale fuso orario sia stato osservato questo problema.)

Sono state osservate latenze elevate sui seguenti proxy API a partire dalle ore 15:30 IST del 9/11/2020 fino alle ore 18:10 IST del 9/11/2020…

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

(Non è chiaro in quale giorno e per quanto tempo si è verificato il problema nell'ultima settimana.)

Configurazione

Abbiamo bisogno di conoscere i dettagli su dove esattamente stai riscontrando il problema. A seconda del prodotto che utilizzi, abbiamo bisogno delle seguenti informazioni:

  • Se utilizzi Apigee Cloud, potresti avere più di un'organizzazione, quindi abbiamo bisogno di conoscere l'organizzazione specifica e altri dettagli in cui si verifica il problema:
    • Nomi dell'organizzazione e dell'ambiente
    • Nome del proxy API e numeri di revisione (per gli errori di richiesta API)
  • Se utilizzi Private Cloud , potresti utilizzare una delle numerose topologie di installazione supportate. Pertanto, dobbiamo 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 COSA FARE e informazioni incomplete nella colonna COSA NON FARE:

Azioni consigliate Azioni da evitare

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

Dettagli di configurazione dell'edge:

I dettagli dell'API non riuscita sono i seguenti:
  Nomi delle organizzazioni: myorg
  Nomi degli ambienti: test
  Nomi dei 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"}}}

Gli errori 401 sono aumentati.

Non fornisce informazioni sul prodotto in uso, da quando viene osservato il problema o dettagli di configurazione.

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

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

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

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

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

Artefatti utili

Fornendo artefatti correlati al problema, puoi velocizzare la risoluzione, in quanto ci aiutano a comprendere il comportamento esatto che stai osservando e ottenere maggiori informazioni al 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 Public Cloud e Apigee Edge su Private Cloud:

Artefatto Descrizione
Output dello strumento Trace L'output dello strumento Trace contiene informazioni dettagliate sulle richieste API che scorrono attraverso i prodotti Apigee. Ciò è 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 osservati, 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. Può essere acquisito utilizzando browser come Chrome, Firefox o Internet Explorer.
tcpdumps Lo strumento tcpdump acquisisce i pacchetti TCP/IP trasferiti o ricevuti tramite la rete. Ciò è utile per qualsiasi problema correlato alla rete, ad esempio errori di handshake TLS, errori 502 e problemi di latenza e così via.

Artefatti aggiuntivi per Apigee Edge for Private Cloud

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

Artefatto Descrizione
Network Topology Il diagramma della topologia di installazione di Edge che descrive la configurazione di Private Cloud, inclusi tutti i data center, i nodi e i componenti installati in ogni nodo.
Log di diagnostica dei componenti perimetrali 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 non interattivo 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 verificano problemi di installazione o migrazione.

Dump dell'heap I dump dell'heap sono un'istantanea del processo di memoria Java. Questo è utile se si riscontra un utilizzo elevato della memoria o errori OutOfMemory in determinati componenti di Edge.
Dump dei thread Un dump dei thread è uno snapshot di tutti i thread di un processo Java in esecuzione.

Ciò è utile se si osserva un utilizzo elevato della CPU o un carico elevato 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 cloud pubblico.

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 della configurazione di Apigee:
  Nomi delle organizzazioni:
  Nomi degli ambienti:
  Nomi dei proxy API:
  Numeri di revisione:

Passaggi per la riproduzione:

<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 Service Unavailable nella nostra organizzazione Public Cloud. Potresti esaminare il problema e risolverlo o consigliarci 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 persiste.

Dettagli della 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:

Esegui questo comando curl per riprodurre il problema:

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

Informazioni di diagnostica:

Output dello strumento di tracciamento (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 della 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, se possibile>

Informazioni di diagnostica

<List of files attached>

Caso di esempio

Questa sezione fornisce un caso 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, si è verificato 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 della configurazione di Edge Private Cloud:

Allegato il file network-topology.png

Passaggi per la riproduzione:

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:

Ha allegato 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