Análise

Introdução

A página Analytics dentro do API Manager permite que você revise as métricas de consumo e desempenho para APIs personalizadas, serviços OData e APIs proxy. Os dados são exibidos em vários gráficos e tabelas correlacionadas.

Para obter mais informações sobre como configurar e executar uma API, consulte estes recursos:

• APIs personalizadas
• Serviços OData
• APIs de proxy

Acesse a Página Analytics

A página Analytics pode ser acessada pelo menu do portal Harmony ou pelo menu de navegação do API Manager:

• Use o menu do portal Harmony para selecionar API Manager > Analytics:

  

• Ao acessar uma página do API Manager, use seu menu de navegação para selecionar Analytics:

  

Cabeçalho da Página de Análise

O cabeçalho na parte superior da página Analytics inclui o menu de navegação e os filtros do API Manager:

Você pode ajustar os dados que cada gráfico exibe, bem como o período de tempo e a escala do gráfico, usando os menus suspensos Filtrar por e Exibir dados.

Filtrar por

Os menus suspensos Filtrar por permitem que você exiba critérios de destino específicos em qualquer combinação de ambientes, APIs, perfis, códigos de status e versões, conforme necessário.

Cada filtro exibe uma lista suspensa de critérios da qual você pode selecionar um ou vários critérios.

Estes são os critérios disponíveis para filtrar:

• Ambientes: Use o menu suspenso para selecionar ambientes onde as APIs estão localizadas. Quando todos os filtros são desmarcados, os ambientes para todas as APIs na organização às quais você tem acesso são exibidos.

• APIs: Use o menu suspenso para selecionar APIs publicadas dentro da organização. Quando todos os filtros estiverem desmarcados, todas as APIs na organização às quais você tem acesso serão exibidas.

  Nota

  APIs publicadas anteriormente que se tornarem não publicadas não aparecerão no menu suspenso APIs. Os logs de API para essas APIs estarão presentes na página Logs de API, mas não poderão ser filtrados.

• Perfis: Selecione os perfis de segurança para filtrar os logs. O menu suspenso exibe os perfis de segurança criados dentro da organização.

• Códigos de status: Use o menu suspenso para selecionar os grupos de códigos de status de resposta HTTP, selecionando entre Sucesso (2xx), Redirecionamentos (3xx), Erros do cliente (4xx) e Erros do servidor (5xx). Quando todos os filtros são desmarcados, todos os códigos de status de resposta HTTP para APIs nas organizações às quais você tem acesso são exibidos. Para obter mais informações sobre códigos de status, consulte definições de código de status do w3.org.

• Versões: Use o menu suspenso para selecionar o número da versão das APIs. Quando todos os filtros estiverem desmarcados, todas as versões das APIs na organização às quais você tem acesso serão exibidas.

Exibir Dados

Os menus suspensos Exibir dados permitem que você filtre os dados analíticos dentro de um período de tempo específico:

O primeiro menu suspenso permite que você selecione a unidade de tempo. Selecione um de Dias, Horas, Minutos ou Segundos. A configuração padrão para a unidade de tempo é Dias.

O segundo menu suspenso permite que você selecione o período de tempo. Selecione um de Últimos 10 minutos, Última 1 hora, Últimas 10 horas, Últimas 24 horas, Últimos 7 dias, Último 1 mês ou Período personalizado. A configuração padrão para o período de tempo é Últimos 7 dias.

Selecionar Período personalizado permite que você filtre o tráfego por um período de tempo especificado. Quando esta opção é selecionada, os campos de calendário adicionais De e Para são exibidos:

• De: Clique para ajustar a data e hora de início dos dados analíticos.
• Para: Clique para ajustar a data e hora de término dos dados analíticos.

Após clicar nos campos de calendário De ou Para, uma caixa de diálogo de calendário é exibida onde você seleciona a data e a hora:

Opções Adicionais

Opções adicionais são exibidas diretamente acima do primeiro gráfico:

• Exibir última atualização: Exibe a última vez que os dados foram atualizados dinamicamente ou manualmente. O horário é exibido no formato h:mm:ss.

• Atualizar: Clique para atualizar os dados analíticos com base nos filtros aplicados e critérios de pesquisa.

• Baixar como CSV: Clique para baixar os dados analíticos atuais com base nos filtros aplicados e critérios de pesquisa.

  Nota

  O campo de data dentro do arquivo CSV é um registro de data e hora UNIX que exigirá conversão se você quiser usar um formato de data e hora diferente.

Acessos

O gráfico Hits exibe o número de hits da API por unidade de tempo selecionada no período de tempo selecionado. Neste exemplo, a unidade de tempo é Days e o período de tempo é Last 1 Month:

Os hits da API são representados graficamente como três conjuntos de dados: valores médios, mínimos e máximos. Cada conjunto é usado para os cálculos de resumo exibidos no gráfico à direita do gráfico.

Passe o mouse sobre qualquer ponto de dados para exibir as métricas:

Você pode baixar os dados exibidos no gráfico para um arquivo CSV. Para obter mais informações, consulte Opções adicionais acima.

Tempos de Resposta

O gráfico Tempos de Resposta exibe os tempos de resposta em milissegundos para a API(s) por unidade de tempo selecionada no período de tempo selecionado. Neste exemplo, a unidade de tempo é Dias e o período de tempo é Último Mês:

Os tempos de resposta da API são representados graficamente como três conjuntos de dados: valores médios, mínimos e máximos. Cada conjunto é usado para os cálculos de resumo exibidos no gráfico à direita do gráfico.

Passe o mouse sobre qualquer ponto de dados para exibir as métricas:

Você pode baixar os dados exibidos no gráfico para um arquivo CSV. Para obter mais informações, consulte Opções adicionais acima.

Código de Status

O gráfico Status Code exibe os códigos de status da API por unidade de tempo selecionada no período de tempo selecionado. Neste exemplo, a unidade de tempo é Days e o período de tempo é Last 1 Month:

Passe o mouse sobre qualquer ponto de dados para exibir as métricas:

Você pode baixar os dados exibidos no gráfico para um arquivo CSV. Para obter mais informações, consulte Opções adicionais acima.

Monitoramento de Saúde da API

A tabela Monitoramento de integridade da API mostra uma lista de API personalizada ativa ou de execução lenta chamadas (ocorrendo dentro de um período de tempo definido) e seus tempos de resposta:

• Limite de resposta: Insira o limite de resposta (em segundos) para exibir chamadas de API personalizadas com um tempo de resposta igual ou maior que o limite fornecido. O valor padrão é 5 segundos e o valor mínimo permitido é 1 segundo. O número fornecido deve ser um inteiro.

• Todas as APIs ativas: Clique para alternar a tabela entre mostrar apenas APIs personalizadas cujo Tempo de resposta seja igual ou maior que_ o Limite de resposta fornecido (desativado) ou mostrar todas as APIs personalizadas ativas (ativadas) dentro do período de tempo fornecido. Quando ativado, o campo Limite de resposta é desativado.

• Download: Baixa um arquivo CSV dos dados da tabela atual com base nos filtros aplicados.

• Nome da API: O nome da API personalizada. Para alterar a ordem de classificação de decrescente (padrão) para crescente, clique nas setas ao lado do nome da coluna.

• Versão: A versão da API personalizada (se fornecida).

• Nome do serviço: O nome do serviço da API.

• Método: O método de solicitação do serviço de API.

• URL do serviço API: O URL do serviço API.

• Chamadas de API: O número total de chamadas para a API personalizada dentro do período fornecido.

• Tempo médio de resposta (seg): O tempo médio de resposta (em segundos) para a chamada de API personalizada.

Gráfico de Consumo

O gráfico de consumo exibe as 10 principais métricas de consumo dentro do período selecionado:

• 10 principais endereços IP: Os 10 principais endereços IP que acessam as APIs criadas no API Manager.
• Top 10 Apps ou Consumers: Os 10 principais consumidores que acessam as APIs criadas no API Manager.
• Top 10 APIs: As 10 principais APIs consumidas pelos endereços IP e consumidores de API.