Bonnes pratiques relatives aux demandes d'assistance Google Cloud Apigee

Vous consultez la documentation d'Apigee et d'Apigee hybrid.
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 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 doit contenir les informations clés suivantes pour chacun des produits Apigee :

Key information	Description	Apigee sur Google Cloud	Apigee hybrid
Produit	Produit Apigee dans lequel le problème est observé, y compris les informations de version le cas échéant.		Version hybride
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 Debug Étapes permettant de reproduire le problème Requête/commande API complète	Message d'erreur Résultat de l'outil Debug Étapes permettant de reproduire le problème Requête/commande API complète Journaux de diagnostic des composants Métriques Cloud Monitoring
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 Nom du projet Google Cloud Nom de l'organisation hybride Nom de l'environnement hybride Plate-forme d'exécution hybride et sa version Nom et région du cluster Kubernetes

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

Produit

Il existe différents produits Apigee, Apigee sur Google Cloud et Apigee hybrid. Nous avons donc besoin d'informations spécifiques sur le produit qui rencontre un 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 À NE PAS FAIRE

À FAIRE	À NE PAS FAIRE
Le déploiement du proxy d'API `OAuth2` a échoué sur notre organisation Apigee sur Google Cloud…	Échec du déploiement du proxy d'API (Nous devons connaître le produit Apigee dans lequel vous rencontrez le problème.)
L'erreur suivante est renvoyée lors de l'accès à Cassandra à l'aide de `cqlsh` sur la version hybride 1.3 d'Apigee…	Impossible d'accéder à Cassandra avec `cqlsh`. (Informations sur la version hybride manquantes)

Le déploiement du proxy d'API OAuth2 a échoué sur notre organisation Apigee sur Google Cloud…

Échec du déploiement du proxy d'API

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

L'erreur suivante est renvoyée lors de l'accès à Cassandra à l'aide de cqlsh sur la version hybride 1.3 d'Apigee…

Impossible d'accéder à Cassandra avec cqlsh.

(Informations sur la version hybride 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 À NE PAS FAIRE

À FAIRE	À NE PAS 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.)

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.)

Temps

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 À NE PAS FAIRE

À FAIRE	À NE PAS 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.)

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éparation

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 une architecture hybride, vous utilisez peut-être l'une des nombreuses plates-formes hybrides compatibles et des topologies d'installation. Nous devons donc connaître la plate-forme hybride et 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 À NE PAS FAIRE

À FAIRE	À NE PAS FAIRE
Les erreurs `401` ont été observées sur Apigee sur Google Cloud depuis le 06/11/2020 09:30 CST. Informations sur la configuration Apigee : 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.)
Debug échoue avec l'erreur suivante sur Apigee hybrid version 1.3 Erreur : `Error while Creating trace session for corp-apigwy-discovery, revision 3, environment dev.` `Failed to create DebugSession {apigee-hybrid-123456 dev corp-apigwy-discovery 3 ca37384e-d3f4-4971-9adb-dcc36c392bb1}` Informations de configuration Apigee hybrid : Plate-forme hybride Apigee : Anthos GKE On-Prem version 1.4.0 Projet Google Cloud, organisation hybride et environnement ID de projet Google Cloud : `apigee-hybrid-123456` Organisation hybride Apigee : `apigee-hybrid-123456` Environnement hybride Apigee : `dev` Détails du nom du cluster Kubernetes k8sCluster : nom : `user-cluster-1` région : `us-east1` Topologie de réseau Fichier `network-topology.png` joint.	Debug échoue sur la solution Apigee hybrid.

Les erreurs 401 ont été observées sur Apigee sur Google Cloud depuis le 06/11/2020 09:30 CST.

Informations sur la configuration Apigee :

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.)

Debug échoue avec l'erreur suivante sur Apigee hybrid version 1.3

Erreur :

Error while Creating trace session for corp-apigwy-discovery, revision 3, environment dev.

Failed to create DebugSession {apigee-hybrid-123456 dev corp-apigwy-discovery 3 ca37384e-d3f4-4971-9adb-dcc36c392bb1}

Informations de configuration Apigee hybrid :

Plate-forme hybride Apigee :
Anthos GKE On-Prem version 1.4.0
Projet Google Cloud, organisation hybride et environnement
ID de projet Google Cloud : apigee-hybrid-123456
Organisation hybride Apigee : apigee-hybrid-123456
Environnement hybride Apigee : dev
Détails du nom du cluster Kubernetes
k8sCluster :
nom : user-cluster-1
région : us-east1
Topologie de réseau
Fichier network-topology.png joint.

Debug échoue sur la solution Apigee hybrid.

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 sur Google Cloud et Apigee hybrid:

Artefact	Description
Résultat de l'outil Debug	Le résultat de l'outil Debug 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 les environnements hybrides

Dans le cas d'un environnement hybride, nous pouvons avoir besoin d'artefacts supplémentaires qui facilitent un diagnostic plus rapide des problèmes.

Artefact	Description
Plate-forme Apigee hybrid	Spécifiez l'une des plates-formes hybrides compatibles suivantes qui sont utilisées : GKE GKE On-Prem AKS (Azure Kubernetes Service) Amazon EKS GKE sur AWS
Versions d'Apigee hybrid et des composants	Version de la CLI Apigee hybrid : version `apigeectl` Version de l'agent Apigee Connect : `kubectl -n=apigee get pods -l app=apigee-connect-agent -o=json \| jq '.items[].spec.containers[].image'` Version d'Apigee MART : `kubectl -n=apigee get pods -l app=apigee-mart -o=json \| jq '.items[].spec.containers[].image'` Version du synchronisateur Apigee : `kubectl -n=apigee get pods -l app=apigee-synchronizer -o=json \| jq '.items[].spec.containers[].image'` Version Cassandra Apigee : `kubectl -n=apigee get pods -l app=apigee-cassandra -o=json \| jq '.items[].spec.containers[].image'` Version d'exécution Apigee : `kubectl -n=apigee get pods -l app=apigee-runtime -o=json \| jq '.items[].spec.containers[].image'` CLI Kubernetes et versions de serveur : version `kubectl` CLI Istio et versions du serveur : version `istioctl`
Topologie du réseau	Le schéma de topologie d'installation Apigee décrivant votre configuration hybride, y compris tous les centres de données, les clusters Kubernetes, les espaces de noms et les pods.
Fichier YAML de remplacement	Le fichier `overrides.yaml` utilisé dans chaque centre de données pour l'installation du plan d'exécution Apigee hybrid.
État du déploiement Apigee hybrid	Le résultat des commandes suivantes dans chaque centre de données ou cluster Kubernetes : `kubectl get pods -A` `kubectl get services -A`
Journaux des composants Apigee hybrid	Fournissez des liens vers les journaux Stackdriver pour les composants hybrides OU Vous pouvez récupérer les journaux des composants hybrides Apigee à l'aide des commandes suivantes dans chaque centre de données ou cluster Kubernetes, puis les partager avec nous : `kubectl -n {namespace} get pods` `kubectl -n {namespace} logs {pod-name}` Journaux de l'agent Apigee Connect : `kubectl -n {namespace} get pods` `kubectl -n {namespace} logs {apigee-connect-agent-pod-name}` Journaux MART : `kubectl -n {namespace} get pods` `kubectl -n {namespace} logs {apigee-mart-pod-name}` Journaux du synchronisateur : `kubectl -n {namespace} get pods` `kubectl -n {namespace} logs {synchronizer-pod-name}` Journaux Cassandra Apigee : `kubectl -n {namespace} get pods` `kubectl -n {namespace} logs {apigee-cassandra-pod-name}` Journaux d'exécution MP/Apigee (de tous les pods d'exécution Apigee) : `kubectl -n {namespace} get pods` `kubectl -n {namespace} logs {apigee-runtime-pod-name}`
Décrire les journaux	Informations détaillées sur le pod. Ceci est particulièrement utile si vous rencontrez des problèmes tels que des pods bloqués dans l'état `CrashLoopBackoff`. `kubectl -n apigee describe pod {pod-name}`
Cloud Monitoring	Lien vers le tableau de bord des métriques Instantanés de tous les tableaux de bord associés aux métriques Cloud Monitoring

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 Cloud

Modèle

Cette section fournit un exemple de modèle pour Apigee sur Google Cloud.

Problème :

Message d'erreur :

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 :

Informations de diagnostic :

Exemple de demande

Cette section fournit un exemple de demande pour Apigee sur Google Cloud.

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ésultats de l'outil Debug (trace-503.xml)

Hybride

Modèle

Cette section fournit un exemple de demande pour Apigee hybrid.

Problème :

Message d'erreur :

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

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

Informations de configuration Apigee hybrid :

Plate-forme hybride Apigee :
<Fournissez les informations sur la plate-forme sur laquelle vous avez installé Apigee hybrid et sa version.>
Projet Google Cloud, organisation et environnement hybride :
ID de projet Google Cloud :
. <Si vous utilisez Google Kubernetes Engine (GKE), assurez-vous de fournir l'ID du projet où se trouvent les clusters. Si vous utilisez GKE On-Prem, Azure Kubernetes Service ou Amazon EKS, indiquez l'ID du projet vers lequel vous envoyez les journaux.>
Organisation hybride Apigee :
Environnement hybride Apigee :
Apigee hybrid et autres versions de CLI :
version de CLI Apigee hybrid (apigeectl) :
Version Kubectl :
Détails du nom du cluster Kubernetes :
k8sCluster :
nom :
région :
Topologie de réseau :
<Joignez la topologie du réseau décrivant la configuration de votre environnement hybride Apigee, y compris les centres de données, les clusters Kubernetes, les espaces de noms et les pods.>
Fichier YAML de remplacement :
<Joignez le fichier YAML de remplacement.>

Procédure à reproduire

Informations de diagnostic :

Exemple de demande

Cette section fournit un exemple de demande pour Apigee hybrid.

Problème :

Nous rencontrons des erreurs lors de l'exécution d'API de gestion sur la version 1.3 d'Apigee hybrid.

Message d'erreur :

[ERROR] 400 Bad Request
{
"error": {
"code": 400,
"message": "Error processing MART request: INTERNAL_ERROR",
"errors": [
{
"message": "Error processing MART request: INTERNAL_ERROR",
"domain": "global",
"reason": "failedPrecondition"
}
],
"status": "FAILED_PRECONDITION"
}
}

Heure de début du problème (format ISO 8601) : 2020-10-24 10:30 PDT

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

Informations de configuration Apigee hybrid :

Plate-forme hybride Apigee
Version 1.15.1 de GKE
Projet Google Cloud, organisation et environnement hybrides
ID de projet Google Cloud : apigee-hybrid-123456
Remarque : Il s'agit de l'ID du projet où se trouvent les clusters.
Organisation hybride Apigee : apigee-hybrid-123456
Environnement hybride Apigee : dev

Apigee hybrid et autres versions de CLI :
Version de l'interface de ligne de commande hybride Apigee (apigeectl) :
Version : 1.2.0
Validation : ac09109
ID de compilation : 214
Heure de compilation : 2020-03-30T20:23:36Z
Version Go : go1.12

Version Kubectl :
Version du client :

version.Info{Major:"1", Minor:"15", GitVersion:"v1.15.0", GitCommit:"e8462b5b5dc2584fdcd18e6bcfe9f1e4d970a529", GitTreeState:"clean", BuildDate:"2019-06-19T16:40:16Z", GoVersion:"go1.12.5", Compiler:"gc", Platform:"darwin/amd64"}

Version du serveur :

version.Info{Major:"1", Minor:"14+", GitVersion:"v1.14.10-gke.36", GitCommit:"34a615f32e9a0c9e97cdb9f749adb392758349a6", GitTreeState:"clean",

Détails du nom du cluster Kubernetes :
k8sCluster :
nom : user-cluster-1
région : us-east1
Topologie de réseau
Fichier network-topology.png joint
Fichier YAML de remplacement
Fichier overrides.yaml joint

Procédure à reproduire :

Exécutez l'API de gestion suivante pour observer l'erreur :

curl -X GET --header "Authorization: Bearer <TOKEN>" "https://apigee.googleapis.com/v1/organizations/apigee-hybrid-123456/environments/dev/keyvaluemaps"

Informations de diagnostic :

Les fichiers suivants sont joints :

network-topology.png
overrides.yaml file
Journaux MART
Journaux du synchronisateur