Voici quelques problèmes courants et les étapes de dépannage correspondantes pour l'intégration du connecteur du hub d'API.
Les métadonnées de l'API ne s'affichent pas dans le hub d'API
- Délai de synchronisation initiale : le démarrage de la synchronisation initiale et l'affichage des données de l'API dans le hub d'API peuvent prendre quelques heures. Nous vous recommandons d'attendre quelques heures.
- État de l'instance de plug-in : vérifiez que l'instance de plug-in dans le hub d'API n'a pas été supprimée ni modifiée.
- ID de la passerelle : assurez-vous que l'ID de la passerelle est correctement configuré dans les paramètres du connecteur de hub d'API Apigee Edge pour Private Cloud.
- Vérifiez les journaux : vérifiez si des erreurs sont consignées dans les journaux du service de connecteur du hub d'API Edge pour Private Cloud
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
.
Proxy déployé, mais les informations du hub d'API ne sont pas exactes
- Délai de propagation : prévoyez quelques minutes pour que les informations sur le proxy déployé se propagent et s'affichent dans le hub d'API.
- Vérifiez les journaux : consultez les journaux du connecteur du hub d'API Edge for Private Cloud pour en savoir plus sur les proxys importés. Cela peut vous aider à déterminer si la mise à jour du proxy a été traitée avec succès pour la synchronisation.
L'organisation utilisateur a cessé de se synchroniser sans que rien n'ait été modifié dans le connecteur du hub d'API
- État de l'instance de plug-in (côté API Hub) : vérifiez si l'instance de plug-in associée dans API Hub a été supprimée, désactivée ou modifiée. Toute modification apportée au hub d'API peut avoir un impact direct sur la synchronisation à partir du connecteur du hub d'API.
- Consultez les journaux : examinez les journaux du connecteur de hub d'API Edge pour Private Cloud afin de détecter les erreurs, les avertissements ou les problèmes qui pourraient indiquer une interruption du processus de synchronisation. Cela peut inclure des problèmes de connectivité ou d'authentification avec le hub d'API.
Utiliser l'API d'état (recommandé pour les organisations ayant activé la fonctionnalité) :
L'API d'état permet de voir directement quelles organisations ont activé la synchronisation et la synchronisent activement.
Dépannage basé sur les journaux
Où sont stockés les journaux du connecteur de hub d'API ?
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Comment obtenir des informations sur les organisations activées ?
Pour déterminer quelles organisations sont actuellement activées et synchronisées, vous pouvez utiliser l'API d'état et inspecter les journaux système.
- Action : appelez le point de terminaison de l'API d'état.
- Résultat attendu : les organisations ayant activé la fonctionnalité seront listées dans les sections
apiSyncStatus
etanalyticsSyncStatus
de la réponse de l'API. Les organisations pour lesquelles la synchronisation des métadonnées est activée s'affichent sousapiSyncStatus
, et celles pour lesquelles la synchronisation de l'exécution est activée s'affichent sousanalyticsSyncStatus
.{ "apiSyncStatus": [ { "organization": "foo", "phase": "Preparing", // ColdTransfer => Preparing "components": [ "proxy": { "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 100, // total proxies known to uapim connector "pendingItems": 90, // pending proxies to upload "completedItems": 6, // completed proxies to upload "failedItems": 4 // proxies failed to upload } }, "environment": { //environment upload status "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 5, // total number of environments "pendingItems": 1, // pending environments to process "completedItems": 3, // completed environment processing "failedItems": 1 // failed environment processing } }] }, { "organization": "bar", "phase": "Processing", // "Streaming" -> "Processing" "components": [ "proxy": { "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 110, // total proxies known to uapim connector "pendingItems": 16, // pending proxies to upload "completedItems": 3, // completed proxies to upload "failedItems": 1 // proxies failed to upload } }, "environment": { "lastUpdated": "2025-04-16T00:56:45Z", "progress": { "totalItems": 5, // total number of environments "pendingItems": 3, // pending environments to process "completedItems": 1, // completed environment processing "failedItems": 1 // failed environment processing } }] }, { "organization": "test", "phase": "Queued", // "Yet to start" -> "Queued" "lastUpdated": "2025-04-16T00:56:45Z" } ], "analyticsSyncStatus": [ { "organization": "test", "environment": "dev", "failedItems": 2, "lastUpdated": "2025-04-16T00:56:45Z" }, { "organization": "test", "environment": "prod", "failedItems": 4, "lastUpdated": "2025-04-16T00:56:45Z" } ] }
- Inspecter les journaux système : pour obtenir une vue plus précise et confirmer la configuration de la synchronisation pour des organisations individuelles, vous pouvez examiner les journaux système pour trouver des entrées spécifiques.
- Vérifiez les journaux :
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Commandes de recherche : utilisez
grep
ou des outils de recherche de journaux similaires pour trouver les lignes de journaux suivantes :- Pour la synchronisation des métadonnées de l'organisation :
grep "Setup metadata sync for organization: metadata-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Exemple d'extrait de journal :
2025-07-10 08:47:09,901 main INFO c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.setupMetadataSync() : Setup metadata sync for organization: metadata-org
- Recherchez le texte Configurer la synchronisation des métadonnées pour l'organisation, suivi du nom de l'organisation.
- Pour la synchronisation des données d'exécution de l'organisation runtime-org :
grep "Setup runtime data sync for organization: runtime-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Exemple d'extrait de journal :
2025-07-10 08:47:09,902 main INFO c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.setupRuntimeSyncData() : Setup runtime data sync for organization: runtime-org
- Recherchez le texte Configurer la synchronisation des données d'exécution pour l'organisation, suivi du nom de l'organisation.
- Pour la synchronisation des métadonnées de l'organisation :
- Vérifiez les journaux :
Comment obtenir des informations sur toutes les organisations et tous les environnements qui n'ont pas pu être activés à partir des journaux ?
Pour obtenir des informations sur les organisations qui n'ont pas pu être activées, vous pouvez examiner les journaux système à la recherche d'entrées d'erreur spécifiques.
- Vérifiez les journaux :
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Commandes de recherche : utilisez
grep
ou des outils de recherche de journaux similaires pour trouver les lignes de journal indiquant une erreur lors de la mise à jour de l'état de la synchronisation des métadonnées.- Pour les mises à jour de l'état de synchronisation des métadonnées ayant échoué pour l'organisation/l'environnement failed-org/failed-env :
grep "Error while updating metadata sync status for org: failed-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Exemple d'extrait de journal :
2025-07-15 10:30:15,123 main ERROR c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.updateMetadataSyncStatus() : Error while updating metadata sync status for org: failed-org
- Recherchez le texte
Error while updating metadata sync status for org/env:
, suivi de l'organisation et de l'environnement (par exemple, failed-org/failed-env).
- Pour les mises à jour de l'état de synchronisation des métadonnées ayant échoué pour l'organisation/l'environnement failed-org/failed-env :
Comment obtenir un récapitulatif des changements d'état du transfert d'une organisation à partir des journaux ?
Pour obtenir un récapitulatif des dates de mise à jour de l'état de transfert de la synchronisation (organisation, environnement), vous pouvez examiner les journaux système pour trouver des entrées spécifiques.
- Vérifiez les journaux :
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Commandes de recherche : utilisez
grep
ou des outils de recherche de journaux similaires pour trouver les lignes de journal indiquant une modification de l'état du transfert pour une organisation et un environnement.- Pour obtenir des informations sur l'état du transfert :
grep "Transfer status is updated for org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Exemple d'extrait de journal :
2025-07-15 18:35:01,789 main INFO c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.updateTransferStatus() : Transfer status is updated for org: org1 to BULK_TRANSFER 2025-07-10 08:47:11,364 main INFO c.a.u.m.UAPIMMetadataServiceImpl - UAPIMMetadataServiceImpl.updateEnvironmentStatus() : Transfer status is updated for org: org1 to STREAMING
- Recherchez le texte exact "L'état du transfert a été mis à jour pour l'organisation/l'environnement", suivi de l'organisation et de l'environnement spécifiques (par exemple, org1/prod) et de l'état.
- Pour obtenir des informations sur l'état du transfert :
Pour afficher les entrées de journaux liées à la collecte et à l'importation de données proto de proxys individuels, vous pouvez rechercher des lignes de journaux spécifiques.
- Emplacement du fichier journal :
/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Commandes de recherche : utilisez
grep
ou des outils de recherche de journaux similaires pour trouver les lignes de journaux indiquant l'importation des données proto collectées pour une organisation et un proxy spécifiques.- Scénario de réussite : le fichier proto du proxy est importé dans le hub d'API. Dans ce cas, recherchez le texte "uploaded collect proto for org: {}, proxy: {}," (fichier proto de collecte importé pour l'organisation {}, proxy {},)
grep "uploaded collect proto for org: your-org-name, proxy: your-proxy-name, with messageId:" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
- Remplacez
-org-name
par le nom réel de l'organisation et your-proxy-name par le nom réel du proxy qui vous intéresse. Exemple d'extrait de journal :2025-07-10 08:47:11,362 main DEBUG c.a.u.m.UAPIMMetadataServiceImpl - UAPIMMetadataServiceImpl.generateCollectProto() : uploaded collect proto for org: org1, proxy: proxy1, with messageId: message_ids: "15569268426032329"
Recherchez le texte "uploaded collect proto for org: " (proto de collecte importé pour l'organisation : ) suivi du nom de l'organisation, puis ", proxy: " (proxy : ) suivi du nom du proxy.
- Scénario d'échec : l'importation du fichier proto du proxy dans le hub d'API a échoué. Dans ce cas, recherchez le texte "Failed to publish collect proto for org: {}, proxy: {}," (Échec de la publication du fichier proto de collecte pour l'organisation {}, le proxy {},)
grep "Failed to publish collect proto for org: your-org-name, proxy: your-proxy-name, " /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Remplacez your-org-name par le nom réel de l'organisation et your-proxy-name par le nom réel du proxy qui vous intéresse.
Exemple d'extrait de journal :2025-07-10 08:47:11,362 main DEBUG c.a.u.m.UAPIMMetadataServiceImpl - UAPIMMetadataServiceImpl.generateCollectProto() : Failed to publish collect proto for org: org1, proxy: proxy1
Recherchez le texte "failed to publish collect proto for org: " (Échec de la publication du proto de collecte pour l'organisation :) suivi du nom de l'organisation, puis ", proxy: " (proxy :) suivi du nom du proxy.
- Scénario de réussite : le fichier proto du proxy est importé dans le hub d'API. Dans ce cas, recherchez le texte "uploaded collect proto for org: {}, proxy: {}," (fichier proto de collecte importé pour l'organisation {}, proxy {},)
Environnement d'exécution/Analytics
Échec de la publication de l'enregistrement sur NFS
Cause : l'utilisation de NFS est supérieure à 75 %.
Pour vérifier : grep "Diskspace usage is at more than 75% of the allocated MaxDiskSpace at" /opt/apigee/var/log/edge-message-processor/logs/system.log
Cause : La synchronisation de l'exécution du connecteur du hub d'API n'est pas activée ou est mal configurée
Vérifiez les éléments suivants dans /opt/apigee/customer/application/message-processor.properties:
conf_message-processor-communication_uapim.enabled.environments=
Assurez-vous que l'organisation et l'environnement corrects sont listés.
conf_message-processor-communication_uapim.runtime.data.path=
Assurez-vous qu'il pointe vers le bon chemin NFS.
Déterminer si les données ont bien été publiées sur le NFS
Les enregistrements sont stockés dans un chemin NFS spécifique, par exemple "/the/nfs/staging".
Vous pouvez vérifier directement le contenu de ce répertoire pour les fichiers nouvellement créés. La présence de fichiers indique que la publication sur NFS a réussi.
Fichier de données supprimé sans traitement
Cause : Le nom de fichier ne contenait pas d'informations valides sur l'organisation/l'environnement.
Journal à vérifier :
grep "Skipped and Deleted file" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Fichier supprimé en raison d'une configuration d'organisation manquante
Cause : configuration spécifique à l'organisation introuvable.
Journal à vérifier :
grep "Deleted file .* due to missing org config" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Fichier supprimé en raison d'un environnement non valide
Cause : L'environnement analysé à partir du nom de fichier n'existe pas dans la configuration de l'organisation.
Journal à vérifier :
grep "Deleted file .* due to invalid env" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Échec de l'importation du fichier vers Pub/Sub
Cause : l'éditeur n'a pas pu être créé (par exemple, compte de service ou sujet mal configuré).
Journaux à vérifier :
grep "Failed to create publisher for org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Importation partielle : échec de l'importation de certains enregistrements
Cause : La publication de certains enregistrements du fichier a échoué.
Journaux à vérifier :
grep "was not completely published" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
Fichier entièrement traité et supprimé
Journal à vérifier :
grep "File .* completely published to topic" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log