Você está vendo a documentação do Apigee Edge.
Consulte a documentação do Apigee X.
Os relatórios personalizados permitem que você obtenha detalhes de métricas específicas da API e visualize os dados exatos que deseja ver. Nos painéis da API Monitoring, você pode criar um relatório personalizado com o filtro e as métricas predefinidos com base nas condições configuradas no momento da criação. Além disso, um conjunto de dimensões e métricas padrão é configurado no relatório para você.
Criar um relatório personalizado com base no seu contexto
Crie rapidamente relatórios personalizados com base no seu contexto, conforme resumido na tabela a seguir. Na página Relatórios personalizados, os relatórios personalizados criados com a API Monitoring têm um nome exclusivo (por padrão), conforme indicado na tabela. É possível alterar o nome ao editar o relatório personalizado.
| Contexto do relatório personalizado | Convenção de nomenclatura padrão para o relatório personalizado |
|---|---|
| Painel recente | API Monitoring Recent Generated |
| Painel da linha do tempo | API Monitoring Timeline Generated |
| Investigar painel | API Monitoring Investigate Generated |
| Condição de alerta | API Monitoring Generated: alert-name |
Dimensões e métricas padrão
Por padrão, o relatório personalizado incluirá as dimensões e métricas listadas na tabela a seguir para todos os relatórios gerados pelo monitoramento de API.
| Componente | Padrões |
|---|---|
| Dimensões | URI da solicitação |
| Métricas |
|
Editar o relatório personalizado
Conforme mencionado na seção anterior, um conjunto predefinido de dimensões e métricas padrão do monitoramento de API é pré-configurado em relatórios personalizados. Depois de criado, você pode editar o relatório personalizado para adicionar ou excluir métricas e dimensões, conforme necessário. Por exemplo, convém restringir sua investigação a um token de acesso, aplicativo de desenvolvedor, proxy de API ou código de solicitação específicos.
No relatório personalizado a seguir, você adiciona a dimensão Gateway Flow ID predefinida, em que Gateway Flow ID contém o UUID exclusivo de cada solicitação de API feita ao Edge.
O relatório já usa a dimensão Request URI:
O exemplo a seguir adiciona a dimensão Client ID ao relatório personalizado.
A dimensão Client ID contém a chave do consumidor (chave de API) do desenvolvedor que faz a chamada da API, seja transmitida na solicitação como uma chave de API ou incluída em um token OAuth:
O relatório personalizado contém informações de todos os valores Client ID.
O próximo exemplo adiciona um filtro para que você possa criar um relatório personalizado para um Client ID específico:
Para mais informações sobre todas as dimensões e métricas predefinidas que podem ser adicionadas a um relatório, consulte a Referência de métricas, dimensões e filtros do Google Analytics.
No próximo exemplo, você adiciona um filtro a um relatório personalizado que captura as métricas e dimensões padrão do código de falha policies.ratelimit.QuotaViolation e os códigos de status 5xx:
Para ver todos os detalhes sobre como editar um relatório personalizado, consulte Gerenciar relatórios personalizados.
Exemplo: usar relatórios personalizados para diagnosticar problemas de implantação
Anexe a política StatisticsCollector aos proxies de API para coletar dados de análise personalizados, como ID do usuário ou do produto, preço, ação REST, versão de destino, URL de destino e tamanho da mensagem. Os dados podem vir de variáveis de fluxo predefinidas pela Apigee, cabeçalhos de solicitação, parâmetros de consulta ou variáveis personalizadas que você define.
Por exemplo, as solicitações para seu proxy de API incluem cabeçalhos para o ID do produto, ID do usuário e versão do servidor de destino. Essa solicitação pode estar no formato:
curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi
Você pode usar as informações nos cabeçalhos para ajudar a diagnosticar problemas de tempo de execução com seu proxy de API.
Para criar um relatório personalizado para esses cabeçalhos:
Adicione a política StatisticsCollector à API para capturar o valor dos cabeçalhos personalizados:
<StatisticsCollector name="publishPurchaseDetails"> <Statistics> <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic> <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic> <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic> </Statistics> </StatisticsCollector>
Implante seu proxy e espere até que ele seja acessado.
Clique em Analyze > API Monitoring > Recent na IU do Edge para ver os problemas da API. Você está recebendo erros 4xx e 5xx para o proxy myapi:
Selecione a linha de proxy myapi para ver mais detalhes no painel à direita do painel "Recentes".
No painel à direita do painel "Recentes", selecione
> Ver em "Investigar" para acessar o painel "Investigar":
Filtre o painel "Investigar" pelo proxy myapi e visualize o Código de status no gráfico superior. Observe que você está recebendo os erros 403 e 501:
Na interface do usuário do Edge, selecione Analytics > Relatórios personalizados > Relatórios para criar um relatório personalizado que inclua os valores dessas métricas personalizadas como uma dimensão.
Selecione + Relatório personalizado para criar um relatório personalizado chamado myapi_errors.
Selecione Erros de proxy para a métrica e defina a Função agregada como a Soma. Você pode adicionar mais métricas se desejar.
Selecione a dimensão predefinida Código de status da resposta e adicione as três estatísticas personalizadas prodid, targetersion e userid às dimensões:
Defina o filtro para incluir apenas dados do proxy de API myapi
(apiproxy eq 'myapi'):
Salve o relatório.
Gere o relatório das 24 horas anteriores. Quando o relatório é aberto pela primeira vez, você vê um gráfico de erros HTTP 403 e 501:
Em Resumo, clique em 403 ou 510 para ver qual produto está gerando os erros. Por exemplo, selecione 403:
Clique em um ID do produto em Resumo para ver os erros por versão de destino (Alfa ou Beta):
Clique em uma versão de destino em Resumo para ver os erros por usuário:
