Best practice per le richieste di assistenza per Apigee di Google Cloud

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

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

Fornire informazioni dettagliate e richieste nella richiesta di assistenza semplifica Il team di assistenza Google Cloud Apigee per risponderti in modo rapido ed efficiente. Quando il team di assistenza caso mancano di dettagli critici, dobbiamo chiedere maggiori informazioni, il che potrebbe comportare più volte avanti e indietro. Questa procedura richiede più tempo e può causare ritardi nella risoluzione dei problemi. Questa guida alle best practice ti permette di conoscere le informazioni di cui abbiamo bisogno per risolvere i tuoi problemi tecnici richiesta di assistenza più rapidamente.

Descrizione del problema

Un problema deve contenere informazioni che spiegano i dettagli di ciò che è successo rispetto a ciò che è stato che si è verificato, nonché quando e come è successo. Una buona richiesta di assistenza Apigee dovrebbe contiene 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 Apigee specifico in cui si verifica il problema, inclusa la versione ove applicabile.
  • Versione
Dettagli del problema Descrizione chiara e dettagliata del problema, che ne delinea le informazioni complete , se presente.
  • Messaggio di errore
  • Output strumento Trace
  • Passaggi per riprodurre il problema
  • Richiesta/comando API completa
  • Messaggio di errore
  • Output strumento Trace
  • Passaggi per riprodurre il problema
  • Richiesta/comando API completa
  • Log della diagnostica dei componenti
Ora Il timestamp specifico in cui è iniziato il problema e quanto è durato.
  • 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 in cui si verifica il problema.
  • Nome organizzazione
  • Nome ambiente
  • Nome proxy API
  • Revisione
  • Topologia di rete
  • Componente con failover

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

Prodotto

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

La tabella seguente fornisce alcuni esempi di informazioni complete nella colonna DO e informazioni incomplete nella Colonna COSA NON FARE:

Cose da fare COSA NON FARE
Deployment del proxy API OAuth2 non riuscito nella nostra organizzazione cloud pubblico ...

Deployment del proxy API non riuscito

(Abbiamo bisogno di sapere il prodotto Apigee in cui riscontri il problema.)

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

Installazione non riuscita nella nostra configurazione del cloud privato.

(Informazioni sulla versione mancanti)

Dettagli del problema

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

La seguente tabella fornisce alcuni esempi di informazioni complete nella colonna DO. e incomplete nella colonna COSA NON FARE:

Cose da fare COSA NON FARE

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 restituisce un errore o risposta imprevista.)

I nostri clienti ricevono 500 errori con il seguente messaggio di errore mentre 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 500 errori durante l'invio di richieste al proxy API.

(La sola comunicazione degli errori 500 non ci fornisce informazioni adeguate per esaminare il problema. Dobbiamo conoscere il messaggio e il codice di errore effettivi essere osservato.)

Ora

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

Il tecnico dell'assistenza che risolve il problema potrebbe non essere nel tuo fuso orario, quindi le relative dichiarazioni sul tempo rendono il problema più difficile da diagnosticare. Per questo motivo, consigliamo di utilizzare Formato ISO 8601 per la data e l'ora per fornire le informazioni esatte relative all'ora in cui è stato rilevato il problema.

La tabella seguente fornisce alcuni esempi che mostrano l'ora e la durata precise per cui problema nella colonna DO e informazioni ambigue o poco chiare sul momento in cui si è verificato un problema nella colonna COSA NON FARE:

Cose da fare COSA NON FARE
Un numero enorme di 503s è stato osservato ieri tra le 17:30 PDT del 6/11/2020 e 2020-11-06 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 in quale fuso orario si verifica il problema è stato osservato.)

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

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

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

Configurazione

Dobbiamo conoscere i dettagli del punto esatto in cui stai riscontrando il problema. In base prodotto che stai utilizzando, abbiamo bisogno delle seguenti informazioni:

  • Se utilizzi Apigee Cloud, potresti avere più di un'organizzazione, quindi abbiamo bisogno per conoscere l'organizzazione specifica e altri dettagli su cui riscontri il problema:
      .
    • Nomi di organizzazioni e ambienti
    • Nome e numeri di revisione del proxy API (per errori delle richieste API)
  • Se utilizzi Private Cloud, è possibile che tu stia utilizzando uno dei tanti supportati topologie di installazione. Dobbiamo quindi sapere quale topologia stai utilizzando, compresi i dettagli come il numero data center e nodi.

La seguente tabella fornisce alcuni esempi di informazioni complete nella colonna DO. e incomplete nella colonna COSA NON FARE:

Cose da fare COSA NON FARE

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

Dettagli di configurazione Edge:

I dettagli dell'API in errore sono i seguenti:
Nomi organizzazione: 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 Gli errori sono aumentati.

(Non fornisce alcuna informazione sul prodotto utilizzato, dal momento che il problema viene osservato o eventuali dettagli di configurazione.)

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

Log di diagnostica:
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 aggiungendo altri nodi gateway.

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

Artefatti utili

Fornendoci gli artefatti relativi al problema accelererai la risoluzione, in quanto ci aiuta a capire il comportamento esatto che stai osservando e a ottenere più informazioni al riguardo.

Questa sezione descrive alcuni elementi utili che sono 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 on Public Cloud e Apigee Edge on Private Cloud:

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

Artefatti aggiuntivi per Apigee Edge per il cloud privato

Per Apigee Edge per Private Cloud, potrebbero essere necessari alcuni artefatti aggiuntivi che faciliteranno una diagnosi dei problemi.

Artefatto Descrizione
Topologia di rete Il diagramma della topologia di installazione Edge che descrive la configurazione del cloud privato, tra cui 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 Message Processore, router o Cassandra.
File di configurazione dell'installazione Il file di configurazione invisibile 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 durante l'installazione o la migrazione.

Dump dell'heap I dump dell'heap sono uno snapshot del processo di memoria Java. È utile se la memoria è elevata di utilizzo o OutOfMemory di errori vengono rilevati su alcuni componenti 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 carico di CPU o un carico elevato su alcuni componenti Edge.

Modelli di richieste e casi di esempio

In questa sezione vengono forniti modelli di richieste e casi d'esempio per diversi prodotti in base al best practice descritte in questo documento:

Apigee Edge su cloud pubblico

Modello

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

Problema:

<Fornisci una descrizione dettagliata del problema o del comportamento osservato da parte tua. Ove applicabile, includi il nome e la versione del prodotto.>

Messaggio di errore:

<Includi l'eventuale messaggio di errore completo osservato>

Ora di inizio del problema (formato ISO 8601):

Ora di fine del problema (formato ISO 8601):

Dettagli di configurazione Apigee:
Nomi delle organizzazioni:
Nomi di ambiente:
Nomi dei 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 503 di servizio non disponibile nel nostro cloud pubblico . Puoi esaminare il problema e risolverlo o darci consigli su 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 in corso.

Dettagli della configurazione di Apigee Cloud:
Nomi organizzazione: 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 strumento di tracciamento (trace-503.xml)

Apigee Edge for Private Cloud

Modello

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

Problema:

<Fornisci una descrizione dettagliata del problema o del comportamento osservato da parte tua. Ove applicabile, includi il nome e la versione del prodotto.>

Messaggio di errore:

<Includi l'eventuale messaggio di errore completo osservato>

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, tra cui 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 di Apigee Management Server sul nodo 10 nell'ambito Edge Private Cloud 4.19.06 su Linux RHEL 7.6, stiamo riscontrando di errore di seguito.

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:

Ha 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 diagnostiche:

In allegato i seguenti file:

  • output.txt contenente l'output completo del comando precedente compreso il messaggio di errore
  • i log del server di gestione
  • File di configurazione NonProdConfig.txt