Como criar e gerenciar relatórios personalizados

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Os relatórios personalizados permitem detalhar as métricas específicas da API e ver os dados exatos. É possível criar um relatório personalizado com qualquer uma das métricas e dimensões integradas à Apigee.

Há dois tipos de relatórios personalizados:

• Relatórios em tempo real (também chamados de relatórios síncronos): quando você especifica os parâmetros na IU da Apigee, os relatórios em tempo real são exibidos IU da Apigee em alguns minutos.
• Jobs de relatório (também chamados de relatórios assíncronos): para jobs de relatório personalizados, você solicita o relatório e recupera os resultados posteriormente.

Consulte Relatórios em tempo real versus jobs de relatório.

Disponibilidade de relatórios personalizados

Se você é um cliente de assinatura da Apigee, o acesso ao Apigee API Analytics e à funcionalidade de relatórios personalizados está incluso nos direitos de assinatura e é ativado automaticamente para cada um dos seus ambientes da Apigee.

Se você é um cliente de Pay-as-you-go, precisará ativar o Apigee API Analytics como um complemento pago para acessar análises e gerar relatórios personalizados. Para mais informações sobre como ativar o complemento Apigee API Analytics nos seus ambientes intermediários ou abrangentes da Apigee, consulte Gerenciar o complemento Apigee API Analytics.

Se você não tiver certeza se está usando uma organização da Apigee por assinatura ou pagamento por uso, entre em contato com o administrador da Apigee.

Sobre relatórios personalizados

Ao criar um relatório personalizado, você seleciona os dados que quer ver (métricas), agrupa-os de modo coerente (dimensões) e, opcionalmente, limita os dados retornados com base em características específicas (filtros).

Também é possível definir o tipo de gráfico exibido no relatório personalizado como uma coluna ou gráfico de linhas. Nas imagens a seguir, mostramos exemplos de gráficos de métricas de transações por segundo agrupadas por dimensão do proxy de API:

• Coluna: cada proxy de API é representado por uma coluna diferente:

  

• Linha: cada API é representada como uma linha diferente:

  

Como definir métricas e dimensões

As métricas escolhidas para seu relatório personalizado especificam os dados que você está avaliando. Veja a seguir algumas métricas comuns:

• Transações por segundo
• Tempo de resposta
• Erros de política

Além das métricas e dimensões padrão, você também pode criar relatórios personalizados para dados personalizados coletados com a política de DataCapture. Consulte Como coletar dados personalizados com a política DataCapture.

É possível definir uma função de agregação para ser executada em algumas métricas. Por exemplo, é possível usar as funções de agregação a seguir com a métrica de tempo de resposta:

• avg: retorna o tempo médio de resposta.
• min: retorna o tempo mínimo de resposta.
• max: retorna o tempo máximo de resposta.
• sum: retorna a soma dos tempos de resposta.

Algumas métricas não aceitam todas as funções de agregação. A documentação sobre métricas inclui uma tabela que especifica o nome da métrica e a função (sum, avg, min, max) que ela aceita.

A dimensão especifica como agrupar os dados das métricas. Por exemplo, se você quer criar um relatório personalizado que mostre a métrica de tempo de resposta, Use as dimensões para agrupar os dados das métricas por produto de API, proxy de API ou e-mail do desenvolvedor (que também pode ser o ID do AppGroup) para saber o seguinte:

• o tempo de resposta por produto de API;
• o tempo de resposta por proxy de API;
• o tempo de resposta por e-mail do desenvolvedor.

A maneira como a dimensão é exibida no gráfico do relatório personalizado depende do tipo de gráfico:

• Coluna: cada coluna corresponde a um valor de dimensão diferente.
• Linha: cada linha do gráfico corresponde a um valor de dimensão diferente, e o eixo x representa o tempo.

Como definir filtros

Um filtro permite limitar os dados de métricas exibidos no relatório personalizado definindo características específicas sobre os dados que serão retornados. Por exemplo, é possível criar um filtro para ver os dados de métricas somente para um tempo de resposta maior que um valor específico ou apenas para um proxy de API com um determinado nome.

É possível criar filtros complexos usando sintaxe e operadores condicionais como eq, ne, gt, lt e muito mais.

Exemplos de relatórios personalizados

No tipo mais simples de relatório personalizado, você especifica uma única métrica e dimensão. Por exemplo, você define um relatório personalizado com as seguintes configurações:

• Tipo = Coluna
• Métrica = Média de transações por segundo
• Dimensão = Proxy de API

O relatório personalizado tem um gráfico de colunas com os dados da métrica "Média de transações por segundo" agrupados pela dimensão do proxy de API:

É possível adicionar várias métricas a um relatório personalizado. Por exemplo, você define um relatório personalizado com duas métricas:

• Tipo = Coluna
• Métrica = Média de transações por segundo
• Métrica = Erros de política
• Dimensão = Proxy de API

O relatório personalizado contém um gráfico separado para cada métrica:

É possível adicionar várias dimensões a um relatório personalizado. Por exemplo, você define um relatório personalizado com as seguintes configurações, que incluem duas métricas e duas dimensões:

• Tipo = Coluna
• Métrica = Média de transações por segundo
• Métrica = Erros de política
• Dimensão = Proxy de API
• Dimensão = Verbo "request"

Relatórios em tempo real versus jobs de relatório

A Análise da Apigee permite gerar um relatório em tempo real ou um job de relatório.

• Para relatórios em tempo real, você solicita o relatório e ele é exibido assim que o servidor de análise fornece uma resposta. No entanto, como um relatório pode precisar processar uma grande quantidade de dados (por exemplo, centenas de GB), um relatório síncrono pode expirar.

  Um relatório em tempo real pode ter um período máximo de 92 dias. Se você selecionar um período maior que esse, o relatório será gerado como um job de relatório.

  Consulte Gerar um relatório personalizado.

• Para um job de relatório, você solicita o relatório e recupera os resultados posteriormente. Algumas situações em que um job de relatório pode ser uma boa alternativa incluem:

  • Análise e criação de relatórios que abrangem períodos longos
  • Análise de dados com uma variedade de dimensões de agrupamento e outras restrições que aumentam a complexidade da consulta
  • Gerenciamento de consultas quando você perceber que os volumes de dados aumentaram significativamente para alguns usuários ou organizações
  Observação: os jobs de relatório têm os seguintes limites:

  • O período máximo é de 365 dias.
  • Limite de tamanho de 32 MB nos resultados de uma consulta.

  Também é possível executar um job de relatório usando a API, conforme descrito em Como usar a API de relatórios personalizados assíncronos. Consulte Visualizar um job de relatório.

Abrir a página Relatórios personalizados

Observação: há uma nova versão da IU da Apigee, que está integrada ao console do Google Cloud. A nova interface é chamada de Apigee no console do Cloud. As instruções nas duas primeiras guias abaixo explicam como usar a Apigee no console do Cloud ou a Apigee clássica.

Apigee no console do Cloud

Para abrir a página Relatórios personalizados:

1. Abra a interface da Apigee no Console do Cloud.
2. Selecione Analytics > Relatórios personalizados.

A página Relatórios personalizados é exibida, conforme mostrado abaixo.

A página Relatórios personalizados tem duas guias:

• Relatórios: exibe relatórios em tempo real.
• Jobs de relatório: exibe os jobs de relatório.

Consulte Relatórios em tempo real versus jobs de relatório.

As duas guias exibem uma lista dos relatórios ou jobs de relatório que já foram criados. Para conferir um relatório ou job de relatório, clique no nome dele. Consulte Gerar um relatório para conferir um exemplo.

Relatórios

A guia Relatórios exibe as seguintes informações sobre cada relatório:

• Nome de exibição: o nome do relatório.
• Dimensões: as dimensões incluídas no relatório.
• Métricas: as métricas e funções de agregação (como soma) incluídas no relatório.
• Última modificação: a última data e hora em que o relatório foi gerado.

Jobs de relatório

A guia Jobs de relatório exibe as seguintes informações sobre cada job de relatório:

• Nome do relatório: o nome do relatório.
• Período de início (UTC): o horário de início do job de relatório.
• Período de término (UTC): o horário de término do job de relatório.
• Status: o status do job de relatório, que pode ser em execução, concluído ou expirado.
• Enviado: a data e a hora em que o job de relatório foi enviado.

A página Relatórios personalizados permite que você:

• Acesse um relatório personalizado e um job de relatório.
• Crie um relatório personalizado ou um job de relatório.
• Gere um relatório.
• Edite um relatório personalizado ou um job de relatório.
• Exclua um relatório personalizado ou um job de relatório.

Observação: intervalo de atraso de dados
Depois que as chamadas de API são feitas para os proxies, pode levar até 10 minutos para que os dados apareçam em painéis, relatórios personalizados e chamadas de API de gerenciamento.

Apigee clássica

Para abrir a página Relatórios personalizados:

1. Faça login na interface da Apigee.
2. Selecione Analisar > Relatórios personalizados > Relatórios.

São exibidos todos os relatórios personalizados que foram criados para sua organização, conforme mostrado na figura a seguir:

Como destacado na figura, na página de relatórios personalizados, é possível:

• ver uma lista de todos os relatórios personalizados;
• adicionar um relatório personalizado;
• clicar no nome de um relatório na lista para personalizá-lo. Por padrão, o relatório é gerado usando os dados coletados na última hora, e os dados são exibidos no painel de relatórios personalizados. Consulte Como explorar o painel de relatórios personalizados;
• pesquisar a lista de relatórios personalizados inserindo toda a string relevante ou parte dela na caixa de pesquisa. A pesquisa pela string é feita em todos os campos exibidos;
• excluir um relatório personalizado.

Como explorar o painel de relatórios personalizados

O painel de relatórios personalizados exibe os resultados de um relatório personalizado durante um período específico, incluindo a coluna ou o gráfico de linhas da métrica especificada:

No painel de relatórios personalizados, é possível:

• ver os dados de relatórios personalizados referentes ao período selecionado;
• selecionar o Ambiente com os dados do relatório personalizado que você quer ver;
• selecionar uma dimensão específica para filtrar os dados do relatório personalizado. Essa área apenas será ativada quando você especificar várias dimensões para o relatório.

• selecionar a visualização gráfica ou em tabela;

  Observação: se o relatório personalizado incluir muitas linhas na tabela de resumo na parte inferior, clique em Tabela para ver somente as informações tabulares. Na visualização em tabela, use a lista suspensa Mostrar até para controlar o número de linhas que serão exibidas na tabela. É possível exibir até 200 linhas de cada vez.
• Analisar uma métrica selecionando o ícone na linha da métrica associada na tabela; ver anomalias e compará-las com um período anterior ou com outras métricas;
• executar o relatório personalizado clicando e definindo o período;
• fazer o download do relatório personalizado como um arquivo CSV. O nome do arquivo é este: metric.csv. Por exemplo: Average_of_total_response_time.csv.
• editar o relatório personalizado.

Observação: intervalo de atraso de dados
Depois que as chamadas de API são feitas para os proxies, pode levar até 10 minutos para que os dados apareçam em painéis, relatórios personalizados e chamadas de API de gerenciamento.

Criar um relatório personalizado

Esta seção explica como criar um relatório personalizado.

Observação: contas gratuitas e de teste não podem criar jobs de relatórios personalizados. Para mais informações, consulte os planos de preços da Apigee.

Apigee no console do Cloud

Na página Relatórios personalizados, você pode criar um relatório em tempo real ou um job de relatório. Para fazer isso, siga estas etapas:

1. Abra a página Relatórios personalizados.
2. Clique em + Criar.
3. • Para criar um relatório em tempo real, selecione Relatório personalizado.
   • Para criar um job de relatório, selecione Job de relatório personalizado.
4. Na seção Básico, digite as seguintes informações:
   • Nome do relatório: o nome do relatório.
   • No caso específico de um relatório em tempo real, também é possível inserir uma descrição opcional.
5. As seções a seguir serão relacionadas à criação de um relatório em tempo real ou de um job de relatório:
   • Somente para relatórios em tempo real:

     Depois de Tipo de gráfico, selecione o estilo do gráfico para apresentar os dados:

     • Coluna: o eixo X representa os grupos designados por dimensões.
     • Linha: o eixo X representa o tempo.

   • Somente para jobs de relatório:
     • Detalhes do relatório: no campo Ambiente, selecione o ambiente em que você quer gerar o relatório. Para relatórios em tempo real, é possível selecionar o ambiente na página do relatório, depois da geração dele.
     • Período do relatório: selecione o horário de início e o horário de término do relatório.

       Observação: o período máximo de um job de relatório é de 365 dias. Para relatórios que precisam de períodos com precisão de segundos, use a API Custom Reports para criar o job do relatório. A API aceita entradas de período que incluem segundos.

6. Na seção Métricas, faça o seguinte:
   1. Selecione a métrica que você quer analisar.
   2. Selecione uma Função de agregação para exibir os valores de soma, média, mínimo ou máximo.
   3. Clique em Concluído.

   Observação: além das métricas e dimensões padrão, você também pode selecionar métricas ou dimensões correspondentes a dados personalizados coletados com a política do DataCapture.

7. No campo Dimensões, selecione uma dimensão, como "Proxy", para restringir o conjunto de dados usado para gerar os relatórios. É possível adicionar outras dimensões para restringir ainda mais os dados.

8. Na seção Filtro, é possível restringir ainda mais os dados exibidos adicionando filtros à definição do relatório. Por exemplo, adicione um filtro que exclua os dados do proxy da API Weather ou da desenvolvedora [e-mail].

   Primeiro, clique em Adicionar um filtro para abrir a seção Novo filtro.

   1. Selecione o nome da entidade que você quer filtrar, que pode ser uma métrica ou uma dimensão.
   2. Selecione um operador como = ou != e um valor.
   3. Insira um valor para a métrica ou dimensão.
   4. Clique em Concluído para adicionar o filtro.
9. Clique em Salvar para salvar o relatório.

Apigee clássica

Para adicionar um relatório personalizado:

1. Abra a página Relatórios personalizados.
2. Clique em + Relatório personalizado.
3. Na seção "Básico", digite as seguintes informações:

   Campo	Descrição
   Nome do relatório	Nome do relatório.
   Descrição do relatório	Descrição do relatório.
   Tipo de gráfico	Selecione o estilo do gráfico que será usado para apresentar os dados personalizados de análise. Coluna: o eixo X representa os grupos designados por dimensões. Linha: o eixo X representa o tempo.

4. Na seção Métricas:
   1. Clique no ícone ao lado de Métricas.
   2. Selecione a métrica que você quer analisar.
   3. Selecione uma Função de agregação para exibir os valores de soma, média, mínimo ou máximo.
   4. Clique em Salvar.
   5. Clique no ícone para adicionar outras métricas.

   Observação: além das métricas e dimensões padrão, você também pode selecionar métricas ou dimensões correspondentes a dados personalizados coletados com a política do DataCapture.

5. Na seção Dimensões, clique em e selecione uma dimensão, como "Proxy", para restringir o conjunto de dados usado para gerar os relatórios. É possível adicionar outras dimensões para restringir ainda mais os dados.

6. Na seção Filtro, restrinja ainda mais os dados exibidos adicionando filtros à definição de relatório. Por exemplo, adicione um filtro que exclua os dados do proxy da API Weather ou da desenvolvedora [e-mail].

   1. Clique em e selecione o nome da entidade que você quer filtrar, um operador como = ou != e um valor.
   2. Clique em Adicionar para salvar o filtro.
   3. Clique em para adicionar outros filtros e selecione um conector AND ou OR.
7. Clique em Salvar para salvar o relatório.

Executar um relatório

Apigee no console do Cloud

Para gerar um relatório em tempo real:

1. Abra a página Relatórios personalizados.
2. Na guia Relatórios, selecione o relatório a ser gerado.

Quando o relatório estiver pronto, ele será exibido como mostrado abaixo.

O relatório exibe um gráfico dos dados e uma tabela de resumo.

Observação: o relatório exibe apenas uma dimensão por vez. Se o relatório tiver várias dimensões, você poderá selecionar a dimensão a ser exibida no campo Dimensão.

Na página do relatório, você pode selecionar as seguintes opções para ele:

• Ambiente: o ambiente em que o relatório será executado.
• Um período para o relatório.
  Observação: o período máximo de um relatório personalizado é de 92 dias. Para criar um relatório com um período maior, é preciso enviá-lo como um job de relatório.
• Dimensão: uma dimensão do relatório. Somente uma dimensão pode ser exibida por vez.
• Valor: um valor específico para a dimensão ou Todos para exibir todos os valores.

Também é possível escolher as seguintes opções na parte superior da página do relatório:

• Editar: edite os detalhes do relatório.
• Exportar: faça o download dos dados do relatório em um arquivo CSV.
• Enviar job: envie o relatório como um job de relatório. Quando você clica em Enviar job, uma caixa de diálogo é aberta com as opções descritas em Criar um relatório personalizado. Depois de inserir as opções, clique em Criar para criar o job de relatório.

Observação: os períodos personalizados não podem exceder 92 dias para relatórios personalizados em tempo real e 365 dias para jobs de relatório.

Consulte Visualizar um job de relatório para mais informações sobre jobs de relatório.

Apigee clássica

Para gerar um relatório personalizado referente a um período específico:

1. Acesse a página "Relatórios personalizados".
2. Selecione o relatório que será gerado. Por padrão, o relatório exibe os dados da hora anterior.

   Observação: se o relatório levar mais de 60 segundos para ser gerado, ele será convertido automaticamente em um relatório em tempo real.

3. Para gerar o relatório de um período diferente:

   1. Clique na área de período na parte superior do relatório para abrir o menu pop-up Seleção de período do relatório personalizado.
   2. Selecione uma destas opções:
      • Um período predefinido, como Última hora, Ontem ou Últimos 7 dias.

      • Um Intervalo personalizado, selecionando uma data e hora De/Até ou usando o calendário para selecionar as datas de início e de término. Clique em UTC para usar o fuso horário UTC.

        Observação: os períodos personalizados não podem exceder 92 dias para relatórios personalizados síncronos e 365 dias para jobs de relatório.
   3. Para gerar o relatório, selecione uma das seguintes opções:

      • Aplicar para gerar o relatório. Os resultados serão exibidos no painel de relatórios personalizados após a conclusão do relatório.

      • Enviar job para gerar o relatório como um job de relatório. A seguinte caixa de diálogo é exibida:

        

        Clique em Conferir status na caixa de diálogo para conferir o status do job de relatório.

Conferir um job de relatório

Apigee no console do Cloud

Para conferir um job de relatório, selecione a guia Jobs de relatório na parte superior da página Relatórios personalizados.

A guia Jobs de relatório é exibida, conforme mostrado abaixo:

Na página Jobs de relatório, é possível:

• Conferir todos os jobs de relatório que foram enviados nos últimos sete dias.

  Observação: os resultados dos jobs de relatório são excluídos após sete dias.

• Selecionar o ambiente com os jobs de relatório que você quer exibir.

• Pesquise na lista de relatórios personalizados inserindo a string inteira ou parte dela na caixa de pesquisa. A pesquisa pela string é feita em todos os campos exibidos.

Para ver o relatório personalizado, verifique se o Status dele é "Concluído". Em seguida, clique no nome do relatório para visualizá-lo.

Observação:

Não é possível acessar um job de relatório que:

• ainda está em execução;
• excede o tamanho máximo de visualização de 2 MB;

Apigee clássica

Para conferir jobs de relatório, selecione uma das seguintes opções:

• Clique em Conferir status na caixa de diálogo Relatório enviado como job em segundo plano.
• Selecione Analisar > Relatórios personalizados > Jobs de relatório na barra de navegação à esquerda.

A página "Jobs de relatório" é exibida, conforme mostrado na figura a seguir:

Na página Jobs de relatório, é possível:

• Conferir todos os resultados de jobs de relatório que foram enviados nos últimos sete dias;

  Observação: os resultados dos jobs de relatório são excluídos após sete dias.

• Selecionar o ambiente com os jobs de relatório que você quer exibir.

• Para ver o relatório personalizado, verifique se o Status dele é "Concluído". Em seguida, passe o cursor do mouse sobre a linha correspondente ao relatório. Os ícones e são exibidos. Selecione para visualizar o relatório.

  Observação:

  Não é possível acessar um job de relatório que:

  • ainda está em execução;
  • excede o tamanho máximo de visualização de 2 MB;
  • não contém dados (0 MB).

• Faça o download do relatório personalizado.

Editar um relatório personalizado

Apigee no console do Cloud

Para editar um relatório personalizado:

1. Abra a página Relatórios personalizados.
2. Clique no menu de três pontos em Ações.
3. Selecione Editar. Isso abre a caixa de diálogo Editar relatório personalizado, em que é possível editar as opções do relatório. As opções estão descritas em Criar um relatório personalizado.
4. Clique em Update to save your changes.

Apigee clássica

Para editar um relatório personalizado:

1. Abra a página Relatórios personalizados.
2. Mova o cursor do mouse sobre o nome do relatório que você quer editar. Os ícones de edição e de exclusão aparecem no lado direito da página.
3. Clique no ícone de edição.
4. Edite os detalhes do relatório personalizado.
5. Clique em Salvar.

Você verá os resultados do relatório personalizado.

Excluir um relatório personalizado

Apigee no console do Cloud

1. Abra a página Relatórios personalizados.
2. Clique no menu de três pontos em Ações.
3. Clique em Excluir para excluir o relatório.

Apigee clássica

Para excluir um relatório personalizado:

1. Abra a página Relatórios personalizados.
2. Mova o cursor do mouse sobre o nome do relatório que você quer editar. Os ícones de edição e de exclusão aparecem no lado direito da página.
3. Clique no ícone de exclusão para excluir o relatório.