Resolver problemas de integração

Confira alguns problemas comuns e as etapas de solução de problemas para a integração do conector do hub de APIs.

Os metadados da API não aparecem no hub de APIs

  • Tempo de sincronização inicial:pode levar algumas horas para que a sincronização inicial comece e os dados da API apareçam no Hub de APIs. Recomendamos que você aguarde algumas horas.
  • Status da instância do plug-in:verifique se a instância do plug-in no hub de API não foi excluída ou alterada.
  • ID do gateway:verifique se o ID correto do gateway está configurado corretamente nas configurações do conector do hub de API do Apigee Edge para nuvem privada.
  • Verifique os registros:confira se há algum erro registrado nos registros do serviço de conector do hub da API Edge para Private Cloud /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log.

O proxy foi implantado, mas as informações no hub de APIs não estão corretas

  • Atraso de propagação:aguarde alguns minutos para que as informações do proxy implantado sejam propagadas e apareçam no hub de API.
  • Verificar registros:analise os registros do conector do hub de APIs do Edge para nuvem privada para ver detalhes sobre os proxies enviados. Isso ajuda a identificar se a atualização do proxy foi processada corretamente para sincronização.

A sincronização da organização do usuário foi interrompida sem que nada fosse alterado no conector do hub de APIs

  • Status da instância do plug-in (lado do hub de APIs): verifique se a instância do plug-in associada no hub de APIs foi desprovisionada, excluída ou alterada. Qualquer mudança no hub de API pode afetar diretamente a sincronização do conector do hub de API.
  • Verificar registros:analise os registros do conector do hub de API do Edge for Private Cloud para identificar erros, avisos ou problemas que possam indicar uma interrupção no processo de sincronização. Isso pode incluir problemas de conectividade ou de autenticação com o hub de API.

A API de status oferece uma maneira direta de ver quais organizações ativaram e estão sincronizando ativamente.

Solução de problemas com base em registros

Onde os registros do conector do hub de APIs são armazenados?

/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log

Como faço para receber informações sobre as organizações ativadas?

Para determinar quais organizações (orgs) estão ativadas e sendo sincronizadas, use a API de status e inspecione os registros do sistema.

  • Ação:chame o endpoint da API de status.
  • Saída esperada:as organizações que ativaram o recurso vão aparecer nas seções apiSyncStatus e analyticsSyncStatus na resposta da API. As organizações com a sincronização de metadados ativada vão aparecer em apiSyncStatus, e as organizações com a sincronização de tempo de execução ativada vão aparecer em analyticsSyncStatus.
    {
     "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"
       }
     ]
    }
    
  • Inspeção de registros do sistema:para uma visão mais granular e para confirmar a configuração da sincronização de organizações individuais, examine os registros do sistema em busca de entradas específicas.
    • Verificar registros:
      /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
    • Comandos de pesquisa:use grep ou ferramentas semelhantes de pesquisa de registros para encontrar as seguintes linhas de registro:
      • Para sincronização de metadados da organização metadata-org:
        grep "Setup metadata sync for organization: metadata-org"  /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
      • Exemplo de snippet de registro:
        2025-07-10 08:47:09,901  main INFO  c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.setupMetadataSync() : Setup metadata sync for organization: metadata-org
      • Procure o texto Configurar a sincronização de metadados para a organização: seguido do nome da organização.
      • Para sincronização de dados de tempo de execução da organização runtime-org:
        grep "Setup runtime data sync for organization: runtime-org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
      • Exemplo de snippet de registro:
        2025-07-10 08:47:09,902  main INFO  c.a.u.c.UAPIMConnectorServiceImpl - UAPIMConnectorServiceImpl.setupRuntimeSyncData() : Setup runtime data sync for organization: runtime-org
      • Procure o texto Configurar a sincronização de dados de tempo de execução para a organização: seguido pelo nome da organização.

Como posso receber informações de todas as (org,env) que não foram ativadas nos registros?

Para informações sobre organizações que não foram ativadas, examine os registros do sistema em busca de entradas de erro específicas.

  • Verificar registros:/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
  • Comandos de pesquisa:use grep ou ferramentas semelhantes de pesquisa de registros para encontrar linhas de registro que indicam um erro durante a atualização do status de sincronização de metadados.
    • Para atualizações de status de sincronização de metadados com falha para org/env 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
    • Exemplo de snippet de registro:
      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
    • Procure o texto Error while updating metadata sync status for org/env: seguido pela organização e pelo ambiente (por exemplo, failed-org/failed-env).

Como posso receber um resumo da mudança de estado da transferência da organização nos registros?

Para ver um resumo de quando um estado de transferência de sincronização (organização, ambiente) é atualizado, examine os registros do sistema em busca de entradas específicas.

  • Verificar registros:/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
  • Comandos de pesquisa: use grep ou ferramentas semelhantes de pesquisa de registros para encontrar linhas de registro que indiquem uma atualização no status da transferência de uma organização e um ambiente.
    • Para atualizações de status da transferência:
      grep "Transfer status is updated for org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
    • Exemplo de snippet de registro:
      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
    • Procure o texto exato "O status da transferência foi atualizado para org/env", seguido pela organização e pelo ambiente específicos (por exemplo, org1/prod) e o estado.
  • Como posso ver os resultados de proxies individuais?

    Para conferir entradas de registro relacionadas à coleta e ao upload de dados proto de proxies individuais, pesquise linhas de registro específicas.

    • Local do arquivo de registro:/opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log
    • Comandos de pesquisa:use grep ou ferramentas semelhantes de pesquisa de registros para encontrar linhas que indicam o upload dos dados proto coletados de uma organização e um proxy específicos.
      • Cenário de sucesso:o proto do proxy é enviado ao hub de API. Nesse caso, pesquise o texto "uploaded collect proto for org: {}, 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
      • Substitua -org-name pelo nome real da organização e your-proxy-name pelo nome real do proxy que você quer. Exemplo de snippet de registro:
        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"

        Procure o texto "uploaded collect proto for org: " seguido pelo nome da organização e ", proxy: " seguido pelo nome do proxy.

      • Cenário de falha:o upload do proto do proxy para o hub de API falhou. Nesse caso, pesquise o texto "Failed to publish collect proto for org: {}, 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

        Substitua your-org-name pelo nome real da organização e your-proxy-name pelo nome real do proxy em que você tem interesse.

        Exemplo de snippet de registro:
        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

        Procure o texto "failed to publish collect proto for org: " seguido pelo nome da organização e ", proxy: " seguido pelo nome do proxy.

    Tempo de execução/análise

    Não foi possível publicar o registro no NFS

    Causa:a utilização do NFS está acima de 75%.

    Para verificar: grep "Diskspace usage is at more than 75% of the allocated MaxDiskSpace at" /opt/apigee/var/log/edge-message-processor/logs/system.log

    Causa: a sincronização do conector do hub de API não está ativada ou está mal configurada

    Verifique o seguinte em /opt/apigee/customer/application/message-processor.properties: conf_message-processor-communication_uapim.enabled.environments=

    Confirme se a organização e o ambiente corretos estão listados.

    conf_message-processor-communication_uapim.runtime.data.path=

    Verifique se ele aponta para o caminho NFS correto.

    Como determinar se os dados foram publicados no NFS

    Os registros são armazenados em um caminho NFS específico, por exemplo, "/the/nfs/staging".

    Você pode verificar diretamente o conteúdo desse diretório para encontrar arquivos recém-criados. A presença de arquivos indica que a publicação no NFS foi bem-sucedida.

    Arquivo de dados excluído sem processamento

    Causa:o nome do arquivo não continha informações válidas sobre a organização/o ambiente.

    Registro a ser verificado: grep "Skipped and Deleted file" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log

    Arquivo excluído devido à falta de configuração da organização

    Causa:não foi encontrada uma configuração específica da organização.

    Registro a ser verificado: grep "Deleted file .* due to missing org config" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log

    Arquivo excluído devido a um ambiente inválido

    Causa: o ambiente analisado do nome do arquivo não existe na configuração da organização.

    Registro a ser verificado: grep "Deleted file .* due to invalid env" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log

    Falha ao fazer upload do arquivo para o Pub/Sub

    Causa:não foi possível criar o publisher (por exemplo, conta de serviço ou tópico configurado incorretamente).

    Registro para verificação: grep "Failed to create publisher for org" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log

    Upload parcial – falha em alguns registros

    Causa:alguns registros no arquivo não foram publicados.

    Registro para verificação: grep "was not completely published" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log

    Arquivo totalmente processado e excluído

    Registro a ser verificado: grep "File .* completely published to topic" /opt/apigee/var/log/edge-uapim-connector/edge-uapim-connector.log