Página de Análise no Jitterbit API Manager

Introdução

A página de Análise no API Manager mostra métricas de consumo e desempenho para APIs personalizadas, APIs OData e APIs proxy. Os dados aparecem em vários gráficos.

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

• APIs Personalizadas
• APIs OData
• APIs Proxy

Acessar a página de Análise

Para acessar a página de Análise, use o menu do portal Harmony para selecionar API Manager > Análise.

Controles da página de Análise

A página de Análise possui controles para filtrar os dados exibidos nos gráficos, definir o período de tempo e gerenciar o layout dos gráficos.

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 de filtro e o seletor de período de tempo.

Filtros de dropdown

Os filtros de dropdown permitem exibir critérios 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 dos quais você pode selecionar um ou vários critérios usando caixas de seleção. Quando os filtros são aplicados a um dropdown, um distintivo de contagem aparece ao lado do rótulo do dropdown, indicando o número de filtros ativos.

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

• Ambiente: Use o dropdown para selecionar os ambientes onde as APIs estão localizadas. Quando nenhum filtro é selecionado, todas as APIs nos ambientes dentro da organização à qual você tem acesso são exibidas.

• APIs: Use o dropdown para selecionar APIs publicadas dentro da organização. Quando nenhum filtro é selecionado, todas as APIs na organização à qual você tem acesso são exibidas.

  Nota

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

• Versão: Use o dropdown para selecionar o número da versão das APIs. Quando nenhum filtro é selecionado, todas as versões das APIs na organização à qual você tem acesso são exibidas.

• Métodos: Use o dropdown para selecionar métodos HTTP. Quando nenhum filtro é selecionado, todos os métodos HTTP para as APIs na organização à qual você tem acesso são exibidos.

• Códigos de Status: Use o dropdown 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 nenhum filtro é selecionado, todos os códigos de status de resposta HTTP para APIs nos ambientes aos quais você tem acesso são exibidos. Para mais informações sobre códigos de status, veja as definições de códigos de status do w3.org.

• Perfis: Use o dropdown para selecionar os perfis de segurança para filtrar os logs. O dropdown exibe perfis de segurança criados dentro da organização.

• Limpar filtros: Clique para remover todos os filtros aplicados em todos os dropdowns. Para adicionar ou remover itens de filtro individuais, clique na caixa de seleção ao lado do nome do item dentro do dropdown. Para limpar todas as seleções de um dropdown de filtro específico, clique em ao lado do badge de contagem do filtro.

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

Seletor de período de tempo

O seletor de período de tempo exibe o intervalo de tempo atualmente selecionado (por exemplo, Última 1 semana) e permite ajustar o intervalo de tempo dos dados analíticos:

Clique no seletor de período de tempo para abrir um diálogo com duas abas: Relativo e Absoluto.

Aba Relativa

A aba Relativa fornece intervalos de tempo predefinidos e um seletor de período de tempo relativo personalizado:

Selecione um dos intervalos de tempo predefinidos:

• Última 1 hora: Exibe dados analíticos da última hora.

• Último 1 dia: Exibe dados analíticos do último dia.

• Última 1 semana: Exibe dados analíticos da última semana.

• Último 1 mês: Exibe dados analíticos do último mês.

Para criar um período de tempo relativo personalizado, use os controles na parte inferior do diálogo:

• Campo numérico: Insira o número de unidades de tempo (por exemplo, 1, 7, 30).

• Dropdown de unidade: Selecione a unidade de tempo entre Minutos, Horas, Dias, Semanas ou Meses.

• Cancelar: Feche o diálogo sem aplicar alterações.

• Aplicar: Aplique o intervalo de tempo selecionado e feche o diálogo.

Aba Absoluta

A aba Absoluta permite selecionar uma data e um intervalo de tempo específicos dentro dos últimos 30 dias:

O intervalo de datas selecionado é exibido na parte superior do diálogo no formato MM/DD/YYYY, HH:mm am/pm - MM/DD/YYYY, HH:mm am/pm.

Configure o intervalo de data e hora usando os seguintes controles:

• Campo de hora de início: Exibe a hora de início para o intervalo. Clique para limpar ou clique para ajustar a hora.

• Campo de hora de término: Exibe a hora de término para o intervalo. Clique para limpar ou clique para ajustar a hora.

• Seletor de calendário: Use o calendário para selecionar as datas de início e término. Navegue entre os meses usando as setas esquerda e direita.

• Cancelar: Feche o diálogo sem aplicar as alterações.

• Aplicar: Aplique o intervalo de data e hora selecionado e feche o diálogo.

Controles adicionais de período de tempo

Quando um período de tempo é selecionado e exibido no cabeçalho:

• Clique ao lado da exibição do período de tempo para limpar o período de tempo selecionado e retornar ao padrão.

• Clique no ícone de calendário ao lado da exibição do período de tempo para reabrir o diálogo do seletor de período de tempo.

Monitoramento de saúde da API

A tabela de monitoramento de saúde da API mostra uma lista de chamadas de API personalizada que estão lentas ou ativas (ocorrendo dentro de um intervalo 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 a 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 exibição dentro do intervalo de tempo fornecido. Quando desativado, a tabela mostra apenas APIs personalizadas cujo Tempo de Resposta é igual a ou maior que o Limite de Resposta fornecido. Quando ativado, a tabela mostra todas as APIs personalizadas ativas, e o campo Limite de Resposta é desativado.

• 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 da API.

• URL do Serviço da API: A URL do serviço da API.

• Chamadas da API: O número total de chamadas à API personalizada dentro do período de tempo fornecido.

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

• Tempo Mínimo de Resposta: O tempo mínimo de resposta (em segundos) registrado para a chamada da API personalizada.

• Tempo Máximo de Resposta: O tempo máximo de resposta (em segundos) registrado para a chamada da API personalizada.

• Ambiente: O ambiente da API.

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

  Nota

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

• Filtrar colunas: Clique para alterar a visibilidade e a ordem das colunas. O painel lateral Colunas é aberto.

  • Pesquisar: Digite parte ou todo o nome de uma coluna para reduzir a lista àquelas que correspondem ao texto.

  • Mostrar Todas: Tornar todas as colunas visíveis.

  • Mover: Arraste e solte para alterar a posição da coluna em relação às outras.

  • Ocultar: A coluna está visível. Clique para ocultá-la.

  • Mostrar: A coluna está oculta. Clique para mostrá-la.

  • Salvar: Salvar quaisquer alterações nas colunas.

  • Cancelar e Fechar: Fechar o editor de colunas sem salvar alterações.

Controles de exibição do gráfico

Cada gráfico descrito nas seções seguintes inclui dois ícones no canto superior direito que controlam sua exibição:

• Expandir/colapsar: Clique para expandir o gráfico para uma visualização maior ou colapsá-lo de volta ao seu tamanho padrão.

• Arrastar: Clique e arraste para reposicionar o gráfico na página.

Métricas de chamadas

Métricas de chamadas é uma seção colapsável que exibe vários gráficos mostrando o desempenho da API e dados de uso. Clique no cabeçalho da seção para expandir ou colapsar a exibição.

A seção inclui os seguintes gráficos:

• Hits
• Tempo de resposta (ms)
• Códigos de status
• Total de chamadas
• Análise de erros
• Utilização do limite de taxa a nível de organização
• Violações de política
• Insights a nível de método

Hits

O gráfico de Hits exibe o número de chamadas de API ao longo do tempo.

Três distintivos de resumo aparecem acima do gráfico, cada um mostrando um valor métrico para o período de tempo selecionado:

• Min: O número mínimo de chamadas registradas em qualquer período de tempo.
• Média: O número médio de chamadas em todos os períodos de tempo.
• Max: O número máximo de chamadas registradas em qualquer período de tempo.

Cada endpoint da API é representado por uma linha colorida separada, com a URL do endpoint mostrada na legenda. Se mais endpoints forem plotados do que a legenda pode exibir, um indicador +N aparece; passe o mouse sobre ele para ver as URLs dos endpoints restantes.

Passe o mouse sobre qualquer ponto de dados para exibir uma dica de ferramenta mostrando a data e o número de chamadas para esse endpoint naquele momento.

Tempo de resposta (ms)

O gráfico de Tempo de resposta (ms) exibe os tempos de resposta em milissegundos para APIs ao longo do tempo.

O gráfico mostra três métricas exibidas como distintivos acima do gráfico:

• Min: O tempo de resposta mínimo em milissegundos em qualquer período de tempo.
• Média: O tempo de resposta médio em milissegundos em todos os períodos de tempo.
• Max: O tempo de resposta máximo em milissegundos em qualquer período de tempo.

Cada endpoint da API é representado por uma linha colorida separada, com a URL do endpoint mostrada na legenda. Se mais endpoints forem plotados do que a legenda pode exibir, um indicador +N aparece; passe o mouse sobre ele para ver as URLs dos endpoints restantes.

Passe o mouse sobre qualquer ponto de dados para exibir o tempo de resposta em milissegundos para esse endpoint naquele momento específico.

Códigos de status

O gráfico de Códigos de status exibe a distribuição dos códigos de status HTTP retornados pelas APIs ao longo do tempo.

O gráfico exibe códigos de status HTTP específicos para todas as categorias de resposta: sucesso (2xx), redirecionamento (3xx), erros do cliente (4xx) e erros do servidor (5xx). Isso permite monitorar a distribuição dos códigos de resposta ao longo do tempo.

Passe o mouse sobre qualquer ponto de dados para exibir uma dica mostrando a data e o número de chamadas que retornaram cada código de status naquele momento.

Chamadas totais

O gráfico de Chamadas totais exibe as principais APIs por volume de chamadas dentro do período selecionado.

Use o menu suspenso no canto superior direito para selecionar quais APIs exibir. As opções incluem Top 5 APIs, Top 10 APIs, Top 25 APIs e Todas as APIs.

O gráfico exibe um gráfico de barras mostrando o volume relativo de chamadas para cada API. Cada endpoint de API é representado por uma cor diferente na legenda. Se mais endpoints forem plotados do que a legenda pode exibir, um indicador +N aparece; passe o mouse sobre ele para ver as URLs dos endpoints restantes.

Passe o mouse sobre qualquer barra para exibir uma dica mostrando a URL do endpoint e sua contagem de chamadas.

Análise de Erros

O gráfico de Análise de Erros exibe o número de chamadas de API bem-sucedidas em comparação com chamadas malsucedidas ao longo do tempo, como um gráfico de área empilhada.

O gráfico exibe duas categorias:

• Códigos de status 200-299 (sucesso): Chamadas de API que retornaram uma resposta de sucesso (2xx) ou redirecionamento (3xx).
• Códigos de status 400-599 (erros): Chamadas de API que retornaram um erro do cliente (4xx) ou erro do servidor (5xx).

Passe o mouse sobre qualquer ponto de dados para exibir uma dica mostrando o tempo e o número de chamadas para essa categoria naquele momento.

Utilização do limite de taxa a nível de organização

O gráfico de Utilização do limite de taxa a nível de organização exibe o número médio de chamadas por minuto para a organização durante cada período de tempo.

Passe o mouse sobre qualquer ponto de dados para exibir uma dica mostrando a data e o limite de taxa médio para aquele período de tempo.

Violações de Política

O gráfico de Violações de Política exibe o número de chamadas de API que falharam devido a violações de regras de acesso ao longo do tempo.

As violações de política são categorizadas pelo tipo de falha:

• Autenticação Falhada (401): Chamadas de API que receberam o código de status HTTP 401 (Unauthorized), indicando que a solicitação não possuía credenciais de autenticação válidas.
• Violação de Limite de Taxa (429): Chamadas de API que receberam o código de status HTTP 429 (Too Many Requests), indicando que o limite de taxa foi excedido.

Apenas categorias com dados registrados para o período de tempo selecionado aparecem no gráfico. Se nenhuma violação de política ocorreu durante o período de tempo selecionado, a mensagem "Nenhum dado encontrado." é exibida.

Passe o mouse sobre qualquer ponto de dados para exibir uma dica mostrando a data e o número de violações para essa categoria naquele momento.

Insights de Nível de Método

O gráfico de Insights de Nível de Método exibe a distribuição das chamadas de API por método HTTP (GET, POST, PUT ou DELETE) ao longo do tempo.

O gráfico exibe cada método HTTP com uma cor diferente na legenda. Isso permite analisar quais métodos são usados com mais frequência para acessar as APIs.

Passe o mouse sobre qualquer ponto de dados para exibir o número de chamadas para esse método durante o período de tempo.

Consumidores de API

Consumidores de API é uma seção colapsável que exibe métricas de consumo para as APIs em sua organização. A seção inclui dois gráficos: Apps e Endereços IP.

Apps

O gráfico de Apps exibe os principais consumidores de API (aplicações) por volume de chamadas dentro do período selecionado.

Use o menu suspenso para selecionar o número de apps a serem exibidos. As opções incluem Top 5 apps, Top 10 apps, Top 25 apps e Todos os apps.

O gráfico exibe um gráfico de barras mostrando o volume relativo de chamadas para cada aplicação. Passe o mouse sobre qualquer barra para exibir o número exato de chamadas e o nome da aplicação.

Endereços IP

O gráfico de Endereços IP exibe os principais endereços IP por volume de chamadas dentro do período selecionado.

Use o menu suspenso para selecionar o número de endereços IP a serem exibidos. As opções incluem Top 5 endereços IP, Top 10 endereços IP, Top 25 endereços IP e Todos os endereços IP.

O gráfico exibe um gráfico de barras mostrando o volume relativo de chamadas para cada endereço IP. Passe o mouse sobre qualquer barra para exibir o número exato de chamadas e o endereço IP.