Principais conceitos da análise API Connect

Uma visão geral de como funciona o API Connect analytics.

Como o gateway e os serviços de analítica trabalham juntos

Quando um usuário chama uma de suas APIs publicadas, o gateway que processa a chamada API cria um registro de eventos de API que contém detalhes da chamada API, como o ID do aplicativo, o horário atual, o código de resultado, etc. Para obter uma lista completa de todos os dados armazenados em um registro de evento de API, consulte a referência de campos do registro de evento de API. O gateway armazena em buffer registros de eventos da API para cada chamada API até que um limite de número de eventos ou de tempo decorrido seja atingido. Quando esse limite é atingido, os eventos de API são enviados em massa para o subsistema de analítica. Os eventos da API são enviados pelo gateway ao subsistema de gerenciamento com a função ` TCP `, e, caso ocorra uma falha de rede, o gateway realiza uma nova tentativa. No entanto, o gateway não retém registros de eventos de API não enviados e tenta novamente por tempo indeterminado e, portanto, a entrega de cada registro de evento de API não é garantida.

Draft comment: iainsoed@uk.ibm.com
The docs page for DP is being updated, but current plan is not to link to it, but instead document the threasholds in the APIC docs:) https://www.ibm.com/docs/en/datapower-gateway/latest?topic=analytics-ways-configure-endpoint.

Customizando os dados de analítica que são armazenados para suas APIs

Observação: as análises de consumidores de API que são exibidas no Catálogo de Consumidores dependem das definições de configuração de visibilidade.

Ao configurar uma API na IU do API Manager , você escolhe quais dados são armazenados nos registros de eventos da API para chamadas para essa API com a propriedade activity log A propriedade activity log possui configurações separadas para chamadas API bem-sucedidas e para chamadas API com falha. As opções de log de atividades são:

none - os eventos da API não são registrados.
activity - Registra o URI do recurso da API. activity é a configuração de log padrão para chamadas de API bem-sucedidas
header - registra o URI do recurso da API e os cabeçalhos HTTP.
payload - Registra o URI do recurso da API, cabeçalhos HTTP e payloads de solicitação e resposta. payload é a configuração de log padrão para as chamadas API com falha, pois a carga útil de resposta pode ter informações úteis sobre a causa da falha.

Acessando seus dados de analítica

Você pode visualizar seus dados analíticos nas UIs do API Manager e do Catálogo de Consumidores.

Na UI do API Manager , o proprietário da organização do provedor pode ver dados de analítica para APIs que são publicadas em seus catálogos.
Na UI do Catálogo do Consumidor, o consumidor da API pode ver os dados analíticos das APIs publicadas em sua organização de consumidores.

O número máximo de eventos de API que podem ser acessados a partir das UIs é de 10.000 O número máximo de registros de eventos que podem ser exibidos por página nas UIs é 200..

Também é possível acessar seus dados analíticos usando a CLI do kit de ferramentas ou a API REST.

É possível gerenciar o acesso do usuário aos dados de analítica com Funções e permissões do usuário. Para obter mais informações sobre a visibilidade de dados de análise baseada em usuário, consulte Catálogos, espaços e análises

É possível exportar dados de analítica de suas UIs, no entanto, a exportação da IU não será um método prático se você desejar exportar mais de 200 registros de eventos da API. Use a CLI ou a API REST do kit de ferramentas para exportar mais de 200 registros de eventos de API de uma só vez. Se você acha que talvez queira exportar regularmente todos os seus dados de analítica, considere Transferência de dados de analítica para um sistema de terceiros.

Transferindo seus dados de análise para um sistema de terceiros

Os dados do evento da API que são recebidos de seus gateways podem ser direcionados para um sistema de terceiros, em vez ou além de serem armazenados pelo subsistema de analítica.

Você pode transferir seus dados analíticos para um servidor AWS S3 ou Splunk. Para obter mais informações sobre o descarregamento, consulte Descarregamento de dados analíticos.