Acessando a analítica na IU do API Manager

Como visualizar, analisar e exportar seus dados de analítica da IU do API Manager.

Os dados de analítica são exibidos em painéis na UI do API Manager . Os painéis têm o escopo definido na organização do provedor, no catálogo e no nível de espaço.

A capacidade de acessar dados de analítica em um catálogo ou nível de espaço depende de suas funções e permissões designadas. Para obter mais informações sobre catálogos e espaços, consulte Trabalhando com catálogos e Usando a distribuição em API Connect.

Para acessar o painel de análise com escopo de catálogo, conclua as etapas a seguir:
  1. Na interface do usuário do API Manager, selecione Gerenciar Ícone Gerenciar catálogos no painel de navegação.
  2. Na lista de catálogos disponíveis no Painel do API Manager , selecione o catálogo necessário.
  3. Opcional: Se os espaços estiverem ativados e você quiser ver as análises no escopo de um espaço, então:
    1. Clique na guia Espaços ..
    2. Selecione o espaço que você deseja visualizar
  4. Clique na guia “Analytics ”.Visualização de catálogo do Analytics

Draft comment: iainsoed@uk.ibm.com
Also talk about analytics for API troubleshooting in manager UI. Not really covered anywhere atm

Painéis de análise

Os painéis de analítica na IU do API Manager mostram os dados do evento da API nos escopos da organização, do catálogo e do espaço do provedor.

Os painéis de controle específicos da organização prestadora de serviços podem ser acessados a partir do ícone de análise Ícone de analítica no painel de navegação. Visualização de catálogo do Analytics

Os painéis com escopo definido de espaço são acessados a partir da guia Análise ao visualizar o espaço.

Os painéis a seguir estão disponíveis:
  • Resumo: em uma visão rápida de informações sobre volumes de chamada, latências e quando essas chamadas estão acontecendo.
  • Consumo: total de chamadas API em sua nuvem. Necessário para o licenciamento baseado em consumo
  • APIs: tudo o que você precisa saber sobre quais APIs estão sendo chamadas e quais não.
  • Produtos : quais produtos são os mais populares no total e ao longo do tempo.
    Draft comment: iainsoed@uk.ibm.com
    This dashboard doesn't mean much on the CMC, maybe will change in future: https://ibmapim.slack.com/archives/C016L7RA2RH/p1655806918287239?thread_ts=1655806509.463429&cid=C016L7RA2RH.
  • Consumidores: determine quais organizações de consumidores estão fazendo a maioria das chamadas de API no total e ao longo do tempo.
  • Aplicativos: quais aplicativos são responsáveis pela maioria das chamadas de API no total e ao longo do tempo.
  • Uso de IA: Acompanhe a contagem de tokens de IA e o uso de modelos para ver como os serviços de IA estão sendo usados.
  • Status : Informações críticas sobre sucessos e falhas de chamadas de API, mostrando as taxas de sucesso e de falha ao longo do tempo, juntamente com um detalhamento do código de resposta HTTP.
  • Latency: quanto tempo as APIs levam para retornar uma resposta e a mudança na latência ao longo do tempo.
  • Transferência de Dados: Tudo sobre cargas úteis de solicitação e resposta. Quais APIs, consumidores e aplicativos são responsáveis pelas maiores cargas úteis de solicitação e resposta.
  • Informações do cliente: quem está chamando suas APIs e de quais dispositivos.
    Nota: somente endereços IP acessíveis pela internet podem ser resolvidos para uma localização geográfica.. Os endereços IP internos serão ignorados.
  • Operações de gateway: volume de chamada e informações de latência para cada gateway em cada serviço de gateway. Essas informações podem ser usadas para determinar se o carregamento está sendo distribuído uniformemente ou se um gateway está com desempenho inferior.

Cada gráfico em um painel pode ser exportado como uma imagem PNG ou JPG. Os dados de origem de cada gráfico podem ser exportados como um arquivo JSON ou CSV. Para exportar um gráfico, clique em “Ações” no canto superior direito:Gráfico de pizza de exemplo de analítica

Também é possível ampliar o gráfico para tela cheia clicando em Ícone de tela cheia do Analytics. Para visualizar os dados de origem em formato tabular, clique em Ícone da tabela de analítica.

Visualização de descoberta

Por padrão, a guia Painéis é exibida.. Para visualizar os dados do evento da API no formulário tabular, selecione Descobrir:

Visualização de descoberta do AnalyticsO número máximo de eventos da API que podem ser acessados pela interface do usuário é de 10.000. O número máximo de registros de eventos que podem ser exibidos por página na visualização Descobrir é 200..

É possível customizar as colunas exibidas na seção Filtros .. Você pode classificar a tabela em ordem crescente ou decrescente clicando nos cabeçalhos das colunas.

É possível alternar o gráfico de linha de tempo para um eixo Y logarítmico e exportar os dados para o gráfico clicando em Ações na parte superior direita do gráfico:

Exportar dados do gráfico e alternar menu de linha de tempo

É possível exportar os dados do evento da API da tabela clicando em Ações na parte superior direita da tabela:

Opções do menu de exportação de dados do Analytics

Observação: ao selecionar “Exportar como CSV ou “Exportar como JSON” para exportar a partir da visualização “Descobrir”, apenas os dados exibidos na página atual de resultados serão exportados. Para exportar dados de todas as páginas, selecione “Dados completos como CSV ” ou “Dados completos como JSON ”. Você também pode exportar todos os seus dados analíticos usando a CLI do kit de ferramentas. Para obter mais informações, consulte Exportar seus dados de análise.

Se você observar eventos inesperados do tipo “ HTTP OPTIONS” na visual ização “Discover”, saiba que esses eventos são causados por solicitações do tipo “ CORS ” provenientes de ferramentas de teste de API baseadas em navegador. Para obter mais informações sobre ferramentas de teste e a chamada OPTIONS, consulte Testando uma API.

Filtrando dados exibidos

É possível filtrar os dados exibidos na visualização Painéis e Descobrir definindo filtros (também chamados de consultas). Expanda a seção Filtros para visualizar, definir e aplicar consultas aos dados exibidos:

Configurações de filtros de analítica

É possível salvar e compartilhar as consultas que você definir:
  • As consultas compartilhadas são visíveis para todos os usuários no mesmo escopo Eles não são visíveis para os usuários em um escopo diferente Por exemplo, uma consulta que os usuários da UI do Cloud Manager compartilham não é visível para um usuário da UI do API Manager . Na IU do API Manager , uma consulta criada no escopo do catálogo não é visível para os usuários que estão visualizando dados de analítica no escopo da organização do provedor.
  • Outros usuários não podem editar ou excluir consultas que você compartilha, mas eles podem criar uma consulta duplicada, que eles podem editar e compartilhar.
  • Todas as consultas têm um nome e uma descrição opcional O nome não precisa ser exclusivo.

As consultas salvas podem ser exportadas como sequências para uso em consultas da API REST e da CLI do kit de ferramentas , por exemplo:

Opção do menu de consulta de cópia do Analyticscopia a seguinte sequência de caracteres para a área de transferência:
timeframe=last7days

Definir uma consulta padrão no Analytics

Agora você pode definir uma consulta padrão que é aplicada automaticamente quando você visita as páginas Dashboard ou Discover no Analytics. A consulta padrão é configurada por usuário e por escopo (organização, catálogo ou espaço).
Nota:
  • Somente as consultas compartilhadas podem ser definidas como consultas padrão.
  • Cada escopo pode ter uma consulta padrão por usuário. Uma consulta padrão diferente pode ser definida para cada catálogo e espaço.
  1. Certifique-se de que a consulta que você deseja definir como padrão esteja salva.
  2. Para compartilhar a consulta salva, conclua as etapas a seguir.
    • Clique na guia Saved (Salvo ).
    • No menu de opções, clique em Compartilhar.
    • Na janela de consulta Compartilhar, clique em Compartilhar.
  3. Clique na guia Compartilhado.
  4. No menu de opções, clique em “Definir como consulta padrão ”.Editanalytics_copy_query.png
  5. Na janela Consulta padrão, clique em Padrão.
  6. Para aplicar a consulta padrão imediatamente. Clique em Aplicar. A consulta padrão é aplicada imediatamente a todos os usuários nesse escopo. Se você não clicar em Aplicar depois de definir a consulta padrão, ela será aplicada automaticamente na próxima vez que você visitar as guias Painel ou Descobrir.

Visualização de relatórios..

A visualização de relatórios exibe dados resumidos de longo prazo, em vez de eventos individuais da API.Visualização de relatórios de analítica
Nota: a visualização de relatórios foi introduzida em v10.0.6e não inclui dados que foram gerados antes do upgrade para v10.0.6.

As tendências de volume de chamadas mostram suas APIs mais e menos ativas, o total de chamadas de API bem-sucedidas e com falha, o total de bytes enviados e recebidos e os totais por escopo.Bloco de tendências de volume de chamada de analítica

As tendências de consumo mostram a evolução do número de consumidores, assinaturas e aplicativos ao longo do tempo: Bloco de tendências do consumidor de analítica

O relatório de consumo mostra as tendências de longo prazo das chamadas de API processadas pelos gateways, que são essenciais para obter informações sobre o licenciamento baseado no consumo.relatório de consumo

Os produtos inativos são aqueles que não têm assinaturas e aqueles que não recebem tráfego.Ladrilho de produtos inativos de análise

“Organizações de consumidores inativas” refere-se às organizações de consumidores que não possuem aplicativos, assinaturas, tráfego recente ou qualquer tipo de tráfego.Ladrilho de organizações de consumidores inativas de analítica

A seção "Produtos descontinuados" exibe produtos que foram descontinuados, mas que ainda recebem tráfego.relatório de produtos descontinuados

A seção de tabelas de classificação de volume de chamadas de API mostra tabelas de classificação para APIs, produtos, planos, aplicativos, organizações de consumidores, serviços de gateway e divisão por catálogo. Clique na coluna do nome para ver os dados de cada item.Tabela de tabela de classificação de volume de chamada de análise