Bonnes pratiques relatives aux demandes d'assistance Google Cloud Apigee

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

En fournissant des informations détaillées et requises dans la demande d'assistance, vous permettez à l'équipe d'assistance Apigee de Google Cloud de vous répondre avec rapidité et efficacité. Dans le cas contraire, nous devons demander des informations supplémentaires, impliquant plusieurs échanges. Cela prend plus de temps et peut entraîner des retards de résolution. Ce guide des bonnes pratiques vous indique les informations dont nous avons besoin pour résoudre votre demande d'assistance technique plus rapidement.

Décrire le problème

Un problème doit contenir des informations expliquant ce qui s'est passé et ce qui aurait dû se passer, ainsi que la date et l'origine du problème. Une bonne demande d'assistance Apigee doit contenir les informations clés suivantes pour chacun des produits Apigee :

Informations sur la clé Description Apigee Edge for Public Cloud Apigee Edge pour le cloud privé
Produit Produit Apigee dans lequel le problème est observé, y compris les informations de version le cas échéant.
  • Version
Informations sur le problème Description claire et détaillée du problème, y compris le message d'erreur complet, le cas échéant.
  • Message d'erreur
  • Résultat de l'outil Trace
  • Étapes permettant de reproduire le problème
  • Requête/commande API complète
  • Message d'erreur
  • Résultat de l'outil Trace
  • Étapes permettant de reproduire le problème
  • Requête/commande API complète
  • Journaux de diagnostic des composants
Heure Horodatage spécifique indiquant le début du problème et sa durée.
  • Date, heure et fuseau horaire de l'occurrence du problème
  • Durée du problème
  • Date, heure et fuseau horaire de l'occurrence du problème
  • Durée du problème
Prérequis Informations détaillées de l'endroit où le problème est observé.
  • Nom de l'organisation
  • Nom de l'environnement
  • Nom de proxy d'API
  • Révision
  • Topologie du réseau
  • Composant Edge ayant échoué

Ces concepts sont décrits plus en détail dans les sections suivantes.

Produit

Il existe différents produits Apigee, Apigee Edge sur le cloud public et Apigee Edge sur le cloud privé. Nous avons donc besoin d'informations spécifiques sur le produit qui pose problème.

Le tableau suivant contient des exemples d'informations complètes dans la colonne À FAIRE et des informations incomplètes dans la colonne À NE PAS FAIRE :

À FAIRE
Échec du déploiement du proxy d'API OAuth2 sur notre organisation cloud public...

Échec du déploiement du proxy d'API

(Nous devons connaître le produit Apigee dans lequel vous rencontrez le problème.)

Échec de l'installation en raison de l'erreur suivante sur notre Edge cloud privé version 4.50.00 ...

Échec de l'installation sur notre configuration du cloud privé.

(Informations sur la version manquantes)

Informations sur le problème

Fournissez des informations précises sur le problème observé, y compris le message d'erreur (le cas échéant), le comportement attendu et le comportement réel observé.

Le tableau suivant contient des exemples d'informations complètes dans la colonne À FAIRE et des informations incomplètes dans la colonne À NE PAS FAIRE :

À FAIRE

Le nouveau proxy edgemicro edgemicro_auth échoue avec l'erreur suivante :

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

Le proxy edgemicro créé aujourd'hui ne fonctionne pas

(Le nom du proxy est inconnu. Nous ne savons pas si le proxy renvoie une erreur ou une réponse inattendue).

Nos clients reçoivent des erreurs 500 avec le message d'erreur suivant lorsqu'ils envoient des requêtes au proxy d'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"}}}

Nos clients reçoivent des erreurs 500 lorsqu'ils envoient des requêtes au proxy d'API.

(Le simple fait de transmettre des erreurs 500 ne nous permet pas d'examiner le problème. Nous avons besoin de connaître le message d'erreur et le code d'erreur en cours d'observation.)

Heure

L'heure est une information essentielle. Il est important que l'ingénieur du service d'assistance sache quand vous avez rencontré ce problème pour la première fois, sa durée et l'éventuelle persistance du problème.

Il est possible que l'ingénieur du service d'assistance en charge de la résolution du problème se trouve dans un fuseau horaire différent du vôtre. Par conséquent, les déclarations relatives sur le temps rendent le problème plus difficile à diagnostiquer. Il est donc recommandé d'utiliser le format ISO 8601 pour la date et l'heure afin d'indiquer le moment exact auquel le problème a été observé.

Le tableau suivant fournit des exemples indiquant des informations exactes concernant l'heure et la durée du problème dans la colonne À FAIRE et des informations ambiguës ou peu claires dans la colonne À NE PAS FAIRE :

À FAIRE
Une nombre important de 503s ont été observés hier entre2020-11-06 17:30 PDT et 2020-11-06 17:35 PDT...

Un nombre important de 503s ont été observés hier à 17h30 pendant 5 minutes.

(Nous sommes obligés d'utiliser la date implicite et le fuseau horaire dans lequel ce problème a été observé n'est pas clair.)

Des latences élevées ont été observées sur les proxys d'API suivants du 2020-11-09 15:30 IST au 2020-11-09 18:10 IST ...

Des latences élevées ont été observées sur certains proxys d'API la semaine dernière.

(La date, l'heure et la durée de ce problème sont incertaines.)

Prérequis

Nous avons besoin de détails sur l'emplacement exact du problème. Selon le produit que vous utilisez, nous avons besoin des informations suivantes :

  • Si vous utilisez Apigee Cloud, vous pouvez avoir plusieurs organisations. Nous devons donc connaître l'organisation et d'autres détails concernant le problème :
    • Noms des organisations et des environnements
    • Nom du proxy d'API et numéros de révision (pour les échecs de requêtes d'API)
  • Si vous utilisez le cloud privé , vous utilisez peut-être l'une des nombreuses topologies d'installation compatibles. Nous devons donc connaître la topologie que vous utilisez, y compris des détails tels que le nombre de centres de données et de nœuds.

Le tableau suivant contient des exemples d'informations complètes dans la colonne À FAIRE et des informations incomplètes dans la colonne À NE PAS FAIRE :

À FAIRE

Le nombre d'erreurs 401 a augmenté sur le cloud public Edge depuis le 2020-11-06 09:30 CST.

Informations de configuration Edge :

Les détails de l'API défaillante sont les suivants :
Noms des organisations : myorg
Noms des environnements : test
Noms des proxys d'API : myproxy
Numéros de révision : 3

Erreur :

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

Le nombre d'erreurs 401 a augmenté.

(Ne fournit aucune information sur le produit utilisé, depuis quand le problème est observé ou des informations sur la configuration.)

Impossible de démarrer le processeur de messages sur Edge cloud privé version 4.19.06 après avoir ajouté des nœuds de passerelle supplémentaires.

Journaux de diagnostic :
Les journaux du processeur de messages sont joints.

Topologie de réseau :
Le fichier network-topology.png contenant les nœuds supplémentaires est joint.

Impossible de démarrer le processeur de messages sur Edge cloud privé version 4.19.06 après avoir ajouté des nœuds de passerelle supplémentaires.

(Les journaux du processeur de messages et la topologie du réseau sont manquants).

Artefacts utiles

En nous fournissant des artefacts liés au problème, vous nous aidez à accélérer la résolution, car cela nous aidera à comprendre le comportement exact que vous observez et à obtenir davantage d'informations à son sujet.

Cette section décrit des artefacts qui sont utiles pour tous les produits Apigee :

Artefacts communs pour tous les produits Apigee

Les artefacts suivants sont utiles pour tous les produits Apigee: Apigee Edge sur le cloud public et Apigee Edge sur le cloud privé:

Artefact Description
Résultat de l'outil Trace Le résultat de l'outil Trace contient des informations détaillées sur les requêtes API qui traversent les produits Apigee. Cela se révèle utile pour les erreurs d'exécution, telles que 4XX, 5XX et les problèmes de latence.
Captures d'écran Les captures d'écran permettent de relayer le contexte du comportement réel ou l'erreur en cours d'observation. Cela se révèle utile pour les erreurs ou les problèmes observés, tels que l'interface utilisateur ou Analytics.
HAR (Http ARchive) HAR est un fichier capturé par les outils de session HTTP afin de déboguer les problèmes liés à l'interface utilisateur. Vous pouvez le capturer à l'aide de navigateurs tels que Chrome, Firefox ou Internet Explorer.
tcpdumps L'outil tcpdump capture les paquets TCP/IP transférés ou reçus sur le réseau. Cette fonctionnalité est utile pour les problèmes réseau tels que les échecs de handshake TLS, les erreurs 502, les problèmes de latence, etc.

Artefacts supplémentaires pour Apigee Edge pour le cloud privé

En ce qui concerne Apigee Edge pour le cloud privé, nous pouvons avoir besoin d'artefacts supplémentaires qui facilitent un diagnostic plus rapide des problèmes.

Artefact Description
Topologie du réseau Le schéma de topologie d'installation Edge décrivant votre configuration de cloud privé, y compris tous les centres de données, les nœuds et les composants installés dans chaque nœud.
Journaux de diagnostic des composants Edge Les journaux de diagnostic relatifs aux composants Apigee Edge spécifiques, tels que le processeur de messages, le routeur ou Cassandra.
Fichier de configuration d'installation Fichier de configuration silencieuse utilisé lors de l'installation ou de la mise à niveau d'Apigee Edge.

Ce fichier est utile pour vérifier que tous les paramètres sont corrects en cas de problème d'installation ou de migration.

Empreintes de la mémoire Les empreintes de la mémoire sont un instantané du processus de mémoire Java. Cela est utile si des erreurs d'utilisation de mémoire ou des erreurs OutOfMemory sont observées sur certains composants Edge.
Instantanés des threads Il s'agit d'un instantané de tous les threads d'un processus Java en cours d'exécution.

Cela est utile si un processeur ou une charge élevés sont observés sur certains composants Edge.

Modèles et exemples de demandes

Cette section fournit des modèles et des exemples de demandes pour différents produits selon les bonnes pratiques décrites dans ce document :

Apigee Edge sur le cloud public

Template

Cette section fournit un exemple de modèle pour Apigee Edge sur le cloud public.

Problème :

<Fournissez une description détaillée du problème ou du comportement observé à votre niveau. Incluez le nom du produit et sa version, le cas échéant.>

Message d'erreur :

<Incluez le message d'erreur complet observé (le cas échéant)>

Heure de début du problème (format ISO 8601) :

Heure de fin du problème (format ISO 8601) :

Informations sur la configuration Apigee :
Noms des organisation :
Noms des environnements :
Noms des proxys d'API :
Numéros de révision :

Procédure à reproduire :

<Si possible, indiquez la procédure à suivre pour reproduire le problème>

Informations de diagnostic :

<Liste des fichiers joints>

Exemple de demande

Cette section fournit un exemple de cas pour Apigee Cloud (Apigee sur Google Cloud/Apigee Edge sur le cloud public).

Problème :

Nous constatons un grand nombre d'erreurs 503 de type Service indisponible dans notre organisation de cloud public. Pouvez-vous examiner le problème et nous aider à le résoudre ?

Message d'erreur :

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

Heure de début du problème (format ISO 8601) : 2020-10-04 06:30 IST

Heure de fin du problème (format ISO 8601) : le problème persiste.

Informations sur la configuration Apigee Cloud :
Noms des organisations : myorg
Noms des environnements : dev
Noms des proxy d'API : myproxy
Numéros de révision : 3

Procédure à reproduire :

Exécutez la commande curl suivante pour reproduire le problème :

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

Informations de diagnostic :

Résultat de l'outil Trace (trace-503.xml)

Apigee Edge pour le cloud privé

Template

Cette section fournit un exemple de modèle pour Apigee Edge for Private Cloud.

Problème :

<Fournissez une description détaillée du problème ou du comportement observé à votre niveau. Incluez le nom du produit et sa version, le cas échéant.>

Message d'erreur :

<Incluez le message d'erreur complet observé (le cas échéant)>

Heure de début du problème (format ISO 8601) :

Heure de fin du problème (format ISO 8601) :

Informations sur la configuration du cloud privé Edge :

<Joignez la topologie de réseau décrivant la configuration de votre cloud privé, y compris les centres de données et les nœuds>

Procédure à reproduire :

<Si possible, indiquez la procédure à suivre pour reproduire le problème>

Informations de diagnostic

<Liste des fichiers joints>

Exemple de demande

Cette section fournit un exemple de cas pour Apigee Edge pour le cloud privé.

Problème :

Lors de l'installation d'Apigee Management Server sur le nœud nº10 dans le cloud privé Edge 4.19.06 sur Linux RHEL 7.6, nous rencontrons l'erreur suivante.

Message d'erreur :

<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

Heure de début du problème (format ISO 8601) : se produit à chaque installation

Heure de début du problème (format ISO 8601) : non applicable

Informations sur la configuration du cloud privé Edge :

Vous avez joint le fichier network-topology.png

Procédure à reproduire :

Voici la commande qui a généré l'erreur ci-dessus :

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

Informations de diagnostic :

Les fichiers suivants sont joints :

  • output.txt contenant le résultat complet de la commande ci-dessus, y compris le message d'erreur
  • Journaux de serveur de gestion
  • Fichier de configuration NonProdConfig.txt