Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Este tópico é uma referência para métricas, dimensões e filtros do Analytics. Para mais contexto sobre a utilização destas, consulte a vista geral da API Analytics.
Este tópico mostra os nomes das métricas e dimensões, tal como aparecem na IU e como tem de os usar nas chamadas de API.
- Os nomes da IU são apresentados quando cria e gere relatórios personalizados.
- Use os nomes específicos da API quando obtiver métricas, criar uma definição de relatório ou atualizar uma definição de relatório.
Métrica
Seguem-se as métricas da API que pode obter em relatórios personalizados e chamadas da API Apigee.
| Métrica | Nome a usar na API Apigee | Funções | Descrição |
|---|---|---|---|
| Média de transações por segundo | tps |
Nenhum |
Número médio de transações, ou seja, pedidos de proxy da API, por segundo. Tenha em atenção que, se tiver um número relativamente baixo de transações durante o período, o número médio de transações por segundo pode parecer zero nos relatórios personalizados da IU se o número for inferior a duas casas decimais. Sintaxe da API: |
| Resultado da cache | cache_hit |
soma |
O número de pedidos de API bem-sucedidos que usam o Sintaxe da API: |
| Número de elementos da cache L1 | ax_cache_l1_count |
média, mín., máx. |
Número de elementos na cache L1 (na memória) por transação durante um determinado período. Por exemplo, se escolher Sintaxe da API: |
| Erros de políticas | policy_error |
soma |
O número total de erros de políticas durante o período especificado. Normalmente, os erros de políticas ocorrem intencionalmente. Por exemplo, a política Um erro de política é registado nas estatísticas apenas se o erro resultar numa falha do proxy de API.
Por exemplo, se o atributo A dimensão Nome da política no erro ( Uma falha de destino (como um Sintaxe da API: |
| Erros de proxy | is_error |
soma |
O número total de vezes que os proxies de API falharam durante o período especificado. A falha do proxy pode ocorrer quando uma política falha ou quando existe uma falha de tempo de execução, como um A dimensão Proxy ( Sintaxe da API: |
| Latência de processamento de pedidos | request_processing_latency |
média, mín., máx. |
Quantidade de tempo (média, mínima ou máxima), em milissegundos, que o Apigee demora a processar pedidos recebidos. O tempo começa quando o pedido chega ao Apigee e termina quando o Apigee encaminha o pedido para o serviço de destino. Usando diferentes dimensões, pode examinar as latências de processamento de pedidos por proxy de API, app de programador, região e assim sucessivamente. Sintaxe da API: |
| Tamanho do pedido | request_size |
soma, média, mín., máx. |
Tamanho da carga útil do pedido recebida pelo Apigee, em bytes. Sintaxe da API: |
| Cache de respostas executada | ax_cache_executed |
soma |
O número total de vezes que uma política de Uma vez que a política No entanto, a execução da cache de respostas é 0 se o elemento
Na ferramenta de depuração,
pode clicar no ícone Sintaxe da API: |
| Latência de processamento de respostas | response_processing_latency |
média, mín., máx. |
Quantidade de tempo (média, mínima ou máxima), em milissegundos, que o Apigee demora a processar as respostas da API. O tempo começa quando o proxy de API recebe a resposta do serviço de destino e termina quando o Apigee encaminha a resposta para o autor da chamada original. Usando diferentes dimensões, pode examinar as latências de processamento de respostas por proxy de API, região e assim sucessivamente. Sintaxe da API: |
| Tamanho da resposta | response_size |
soma, média, mín., máx. |
Tamanho do payload de resposta devolvido ao cliente, em bytes. Sintaxe da API: |
| Erros de destino | target_error |
soma |
Número total de respostas Sintaxe da API: |
| Tempo de resposta alvo | target_response_time |
soma, média, mín., máx. |
Quantidade de tempo (soma, média, mínimo ou máximo), em milissegundos, para o servidor de destino responder a uma chamada. Esta métrica indica o desempenho dos servidores de destino. O tempo começa quando o Apigee encaminha um pedido para o serviço de destino e termina quando o Apigee recebe a resposta. Tenha em atenção que, se uma chamada API devolver uma resposta da cache (por exemplo, através da política Sintaxe da API: |
| Tempo de resposta total | total_response_time |
soma, média, mín., máx. |
Quantidade de tempo (soma, média, mínimo ou máximo), em milissegundos, desde o momento em que o Apigee recebe um pedido de um cliente até ao momento em que o Apigee envia a resposta de volta ao cliente. O tempo inclui a sobrecarga da rede (como o tempo que os balanceadores de carga e os routers demoram a fazer o seu trabalho), a latência de processamento de pedidos, a latência de processamento de respostas e o tempo de resposta de destino (se a resposta for publicada a partir do serviço de destino em vez da cache). Usando diferentes dimensões, pode examinar as latências de processamento por proxy de API, app de programador, região, etc. Sintaxe da API: |
| Trânsito | message_count |
soma |
O número total de chamadas de API processadas pelo Apigee no período especificado. Use dimensões para agrupar as contagens de tráfego de formas mais significativas para si. Sintaxe da API: |
| Rentabilização | |||
| Taxas | fees |
soma, média, mín., máx. |
Valor que representa a taxa de configuração, as taxas recorrentes ou a adição de saldo pré-pago. Sintaxe da API: |
| Partilha de receita do programador | x_apigee_mintng_dev_share |
soma, média, mín., máx. |
A parte do programador na receita de uma transação. O Apigee calcula a quota do programador apenas se tiver ativado a partilha de receita no seu plano tarifário. A quota do programador é calculada através da seguinte fórmula: x_apigee_mintng_dev_share = revShareGrossPrice * (share percentage)
O valor da percentagem de partilha é obtido a partir do seu plano tarifário. Sintaxe da API: |
| Preço de rentabilização | x_apigee_mintng_price |
soma, média, mín., máx. |
Receita total de uma transação.
A receita de uma transação é definida com o valor da Sintaxe da API: |
| Multiplicador do preço da API | x_apigee_mintng_price_multiplier |
soma, média, mín., máx. |
O fator (multiplicador) pelo qual o custo por transação é multiplicado. O custo por transação é especificado nos preços das taxas baseadas no consumo do plano tarifário. Sintaxe da API: |
| Taxas de rentabilização | x_apigee_mintng_rate |
soma, média, mín., máx. |
Tarifa cobrada por uma transação. A taxa cobrada por uma transação é calculada através da seguinte fórmula: x_apigee_mintng_rate = (consumption-based pricing rate) * perUnitPriceMultiplier value
O valor da taxa de preços baseada no consumo é obtido do seu plano tarifário e o valor Sintaxe da API: |
Dimensões
As dimensões permitem-lhe ver métricas em agrupamentos significativos. Por exemplo, ver as contagens de tráfego total torna-se muito mais útil quando as vê para cada app de programador ou proxy de API.
Seguem-se as dimensões que o Apigee fornece de imediato.
| Dimensão | Nome a usar na API Apigee | Descrição |
|---|---|---|
| Token de acesso | access_token |
Chave de acesso OAuth do utilizador final da app. |
| Produto de API | api_product |
|
| Nome da app do grupo de apps | app_group_app |
Nome da app que está a ser chamada quando faz parte de um AppGroup. Consulte o artigo Usar grupos de apps para organizar a propriedade das apps para ver informações sobre grupos de apps. |
| Nome do grupo de apps | app_group_name |
Nome do AppGroup que contém as apps que estão a ser chamadas, se aplicável. Consulte o artigo Usar grupos de apps para organizar a propriedade das apps para ver informações sobre grupos de apps. |
| Chave de cache | ax_cache_key |
Chave que contém o valor Na ferramenta de depuração, quando seleciona uma política |
| Nome da cache | ax_cache_name |
Nome da cache que contém as chaves/valores usados pela política Na ferramenta de depuração,
quando seleciona uma política |
| Origem da cache | ax_cache_source |
Nível de cache (L1 na memória ou base de dados L2) a partir do qual o Na ferramenta de depuração,
quando seleciona a política Para mais informações sobre os níveis de cache, consulte o artigo Funcionamento interno da cache. |
| ID do cliente | client_id |
Chave de consumidor (chave da API) da app do programador que faz as chamadas de API, quer seja transmitida no pedido como chaves da API ou incluída em tokens OAuth. Para obter esta dimensão, os proxies que recebem chamadas têm de ser configurados para verificar se existe uma chave da API ou um token OAuth válido. As apps de programadores recebem chaves de API, que podem ser usadas para gerar tokens OAuth, quando as apps são registadas no Apigee. Para mais informações, consulte o artigo Como posso gerar dados de estatísticas completos?. Se os critérios acima não forem cumpridos, é apresentado o valor |
| App Developer | developer_app |
App de programador registada no Apigee que faz chamadas API. Para obter esta dimensão, as apps têm de estar associadas a um ou mais produtos API que contenham os proxies API que estão a ser chamados, e os proxies têm de verificar se existe uma chave da API ou um token OAuth enviado com a chamada API. A chave ou o token identifica a app do programador. Para mais informações, consulte o artigo Como posso gerar dados de estatísticas completos?. Se os critérios acima não forem cumpridos, é apresentado o valor |
| Email do programador | developer_email |
|
| ID de programador | developer |
ID de programador exclusivo gerado pelo Apigee no formato
Para obter esta dimensão, os programadores têm de ter apps associadas a um ou mais produtos de API que contenham os proxies de API que estão a ser chamados, e os proxies têm de verificar se existe uma chave da API ou um token OAuth enviado com as chamadas API. A chave ou o token identifica o programador. Para mais informações, consulte o artigo Como posso gerar dados de estatísticas completos?. Se os critérios acima não forem cumpridos, é apresentado o valor |
| Ambiente | environment |
Ambiente Apigee no qual os proxies de API estão implementados. Por exemplo, test ou prod. |
| Código de falha no erro | ax_edge_execution_fault_code |
O código de falha do erro. Por exemplo:
|
| Nome do fluxo no erro | ax_execution_fault |
Fluxo com nome em
um proxy de API que gerou um erro. Por exemplo, Tenha em atenção que o nome completo a usar na API Apigee é
Quando não ocorrem erros, é apresentado o valor |
| Recurso de fluxo | flow_resource |
Apenas para utilização do Apigee. Consulte o artigo Como usar a dimensão "Fluxo de recursos" no Analytics se tiver curiosidade. |
| Deixar fluir em caso de erro | ax_execution_fault |
Nome dos estados do fluxo do proxy de API que geraram erros, como Tenha em atenção que o nome completo a usar na API Apigee é |
| ID do fluxo do gateway | gateway_flow_id |
À medida que as chamadas API se movem através do Apigee, cada chamada recebe o seu próprio ID do fluxo do gateway. Exemplo: rrt329ea-12575-114653952-1. O ID do fluxo de gateway é útil para distinguir métricas em situações de TPS elevado em que outras dimensões, como organização, ambiente e data/hora, são idênticas em todas as chamadas. |
| Organização | organization |
Organização do Apigee na qual os proxies de API estão implementados. |
| Nome da política no erro | ax_execution_fault |
Nome da política que gerou um erro e fez com que a chamada API falhasse. Tenha em atenção que o nome completo a usar na API Apigee é Se uma política gerar um erro, mas o atributo raiz da política |
| Proxy | apiproxy |
Nome da máquina (não o nome a apresentar) de um proxy de API. |
| Caminho base do proxy | proxy_basepath |
BasePath configurado no ProxyEndpoint do proxy de API. O caminho base não inclui a parte do domínio e da porta do URL do proxy da API. Por exemplo, se o URL base de um proxy de API for
O valor também é armazenado na |
| Tipo de implementação de proxy | proxy_deployment_type |
O
tipo de proxy da API
para proxies implementados. A especificação de um tipo de proxy limita os resultados a esse tipo de proxy. Os valores potenciais são |
| Sufixo do caminho do proxy | proxy_pathsuffix |
Caminho do recurso adicionado ao caminho base do proxy de API. Por exemplo, se o URL base de um proxy de API for Se não for usado nenhum O valor também é armazenado na |
| Revisão do proxy | apiproxy_revision |
Número de revisão do proxy de API que processou as chamadas API. Isto não significa necessariamente a revisão mais recente de um proxy de API. Se um proxy de API tiver 10 revisões, a 8.ª revisão pode estar atualmente implementada. Além disso, uma API pode ter várias revisões implementadas, desde que as revisões tenham caminhos base diferentes, conforme descrito no artigo Implementar proxies. |
| IP do cliente resolvido | ax_resolved_client_ip |
Endereço IP do cliente de origem. Isto é derivado através da resolução do endereço IP do cliente predefinido ou do algoritmo configurado na resolução do IP do cliente configurado. Com o comportamento predefinido, o valor da dimensão Tenha em atenção que, quando usa produtos de encaminhamento, como o Akamai, para capturar os verdadeiros endereços IP dos clientes,
o IP do cliente é transmitido para o Apigee no cabeçalho HTTP O valor da dimensão
|
| Código de estado da resposta | response_status_code |
Código de estado da resposta HTTP encaminhado do Apigee para o cliente, como 200, 404,
503 e assim sucessivamente. No Apigee, o código de estado da resposta do destino pode ser substituído por políticas como a política AssignMessage e a política RaiseFault, motivo pelo qual esta dimensão pode diferir do código de resposta do destino (target_response_code). |
| Anfitrião virtual | virtual_host |
O nome do anfitrião virtual para o qual a chamada API foi feita. Para mais informações, consulte o artigo Acerca dos ambientes e dos grupos de ambientes. |
| Inbound/Cliente | ||
| Endereço IP do cliente | client_ip |
Endereço IP do sistema que atinge o router, como o cliente original
(proxy_client_ip) ou um equilibrador de carga. Quando existem vários IPs no cabeçalho X-Forwarded-For, este é o último IP listado. |
| Categoria do dispositivo | ax_ua_device_category |
Tipo de dispositivo a partir do qual a chamada API foi feita, como Tablet ou Smartphone. |
| Família de SO | ax_ua_os_family |
Família do sistema operativo do dispositivo que está a fazer a chamada, como Android ou
iOS. |
| Versão do SO | ax_ua_os_version |
Versão do sistema operativo do dispositivo que está a fazer a chamada. É útil usar esta opção como uma segunda dimensão de detalhe com a família do SO (ax_ua_os_family) para ver as versões dos sistemas operativos. |
| IP do cliente proxy | proxy_client_ip |
Endereço IP do cliente de chamada, armazenado na |
| IP do cliente referenciado | ax_true_client_ip |
Quando usar produtos de encaminhamento, como o Akamai, para capturar os verdadeiros endereços IP dos clientes,
os IPs dos clientes são transmitidos para o Apigee no cabeçalho HTTP Para determinar o endereço IP do cliente original, acedido através da dimensão |
| Caminho do pedido | request_path |
Caminho do recurso (não incluindo o domínio) para o serviço de destino, excluindo os parâmetros de consulta. Por exemplo, o destino de amostra do Apigee |
| URI do pedido | request_uri |
Caminho do recurso (não incluindo o domínio) para o serviço de destino, incluindo parâmetros de consulta. Por exemplo, o destino de exemplo do Apigee |
| Verbo de pedido | request_verb |
Verbo de pedido HTTP nos pedidos da API, como GET, POST, PUT e DELETE. |
| Agente do utilizador | useragent |
Nome do agente do utilizador ou do agente de software usado para fazer a chamada da API. Exemplos:
|
| Família do agente do utilizador | ax_ua_agent_family |
Família do agente do utilizador, como Chrome Mobile ou curl. |
| Tipo de agente do utilizador | ax_ua_agent_type |
O tipo de agente do utilizador, como Browser, Mobile Browser, Library e assim sucessivamente. |
| Versão do agente do utilizador | ax_ua_agent_version |
Versão do agente do utilizador. É útil usar isto como uma segunda dimensão de detalhe com a família do agente do utilizador (ax_ua_agent_family) para obter a versão da família do agente. |
| Saída/alvo | ||
| Destino | target |
Ponto final de destino que processou o pedido. Por exemplo, default. |
| Caminho base do destino | target_basepath |
Caminho do recurso (não incluindo o domínio) para o serviço de destino, excluindo os parâmetros de consulta, que está definido no Por exemplo, suponhamos que um proxy de API chama o seguinte destino: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> Neste exemplo, o target_basepath é Se o alvo fosse este: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> O target_basepath seria nulo. Na ferramenta de depuração, quando
seleciona o ícone AX no final do diagrama de fluxo, a
|
| Nome do serviço gRPC | x_apigee_grpc_service_name |
Aplicável apenas quando o serviço de destino é gRPC. O nome do serviço gRPC. Para ver informações sobre proxies gRPC, consulte o artigo Criar proxies de API gRPC. |
| Estado do gRPC | x_apigee_grpc_status |
Aplicável apenas quando o serviço de destino é gRPC. O estado do pedido gRPC. Para ver informações sobre proxies gRPC, consulte o artigo Criar proxies de API gRPC. |
| Anfitrião de destino | target_host |
Anfitrião do serviço de destino. Por exemplo, se um proxy de API chamar
http://mocktarget.apigee.net/help, o target_host é
mocktarget.apigee.net. |
| Endereço IP de destino | target_ip |
Endereço IP do serviço de destino que devolve a resposta ao proxy de API. |
| Código de resposta de destino | target_response_code |
Código de estado da resposta HTTP devolvido pelo serviço de destino ao proxy de API, como
Um valor de Isto é diferente da dimensão Código de estado da resposta (response_status_code). |
| Nome da RPC gRPC | x_apigee_grpc_rpc_name |
Aplicável apenas quando o serviço de destino é gRPC. O nome do RPC. Para ver informações sobre proxies gRPC, consulte o artigo Criar proxies de API gRPC. |
| URL de destino | target_url |
URL completo do serviço de destino definido no TargetEndpoint de um proxy de API. <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> Neste exemplo, o target_url é
Tenha em atenção que o URL também pode ser substituído durante o processamento do proxy da API com a
Na encadeamento de proxies, o target_url no proxy de chamada é nulo. |
| IP X-Forwarded-For | x_forwarded_for_ip |
A lista de endereços IP no cabeçalho Para determinar o endereço IP do cliente original, acedido através da dimensão |
| X-Forwarded-For Proto | x_forwarded_proto |
Protocolo que o cliente usou para se ligar ao router. Os valores válidos incluem |
| Hora | ||
| Dia da semana | ax_day_of_week |
Abreviatura de três letras do dia da semana em que as chamadas API foram feitas. Por exemplo, seg, ter, qua. |
| Mês | ax_month_of_year |
O mês numérico em que as chamadas API foram feitas. Por exemplo, 03 para março. |
| Hora do dia | ax_hour_of_day |
Com base num relógio de 24 horas, a hora de 2 dígitos em que foram feitas chamadas API. Por exemplo, as chamadas à API feitas na hora entre as 22:00 e as 23:00, o ax_hour_of_day seria 22. O valor de tempo está em UTC. |
| Fuso horário | ax_geo_timezone |
Nomes comuns dos fusos horários a partir dos quais as chamadas API foram feitas, como
America/New_York e Europe/Dublin. |
| Semana do mês | ax_week_of_month |
Semana numérica do mês. Por exemplo, para chamadas API feitas na 3.ª semana de um mês, o valor de ax_week_of_month é 3. |
| Localização | ||
| Cidade | ax_geo_city |
Cidade a partir da qual foram feitas as chamadas API. |
| Continente | ax_geo_continent |
Código de duas letras do continente a partir do qual foram feitas as chamadas API. Por exemplo,
NA para a América do Norte. |
| País | ax_geo_country |
Código de duas letras do país a partir do qual foram feitas as chamadas API. Por exemplo, US
para os Estados Unidos. |
| Região geográfica | ax_geo_region |
Código com hífen para a região geográfica, como STATE-COUNTRY. Por exemplo,
WA-US para Washington, Estados Unidos. |
| Região | ax_dn_region |
Nome do centro de dados da Apigee onde os proxies de API estão implementados, como
us-east-1. |
| Rentabilização | ||
| Criado | created |
Atualmente disponível em organizações do Apigee, não em organizações do Apigee Hybrid. Data/hora Unix em que a agenda de taxas foi adicionada para o programador de apps e o produto API. |
| Tipo de taxas | fees_type |
Tipo de taxa. Pode ser uma taxa de configuração, uma taxa recorrente ou um recarregamento pré-pago. Este valor
só é preenchido se tiver selecionado a métrica Fees. |
| Moeda da receita | x_apigee_mintng_currency |
|
| ID do plano de tarifas | x_apigee_mintng_rate_plan_id |
Atualmente disponível em organizações do Apigee, não em organizações híbridas do Apigee. O plano de tarifas de rentabilização para o programador de apps. |
| Transação bem-sucedida | x_apigee_mintng_tx_success |
O estado de rentabilização da transação é definido para o valor da variável de rentabilização transactionSuccess capturada na sua política de captura de dados. |
Filtros
Os filtros permitem-lhe limitar os resultados a métricas com características específicas. Seguem-se alguns exemplos de filtros. Use nomes de estilo API de métricas e dimensões quando definir filtros.
Devolve métricas para proxies de API com o nome books ou music:
filter=(apiproxy in 'books','music')
Devolve métricas para proxies de API com nomes que começam por m:
filter=(apiproxy like 'm%')
Devolve métricas para proxies de API com nomes que não começam por m:
filter=(apiproxy not like 'm%')
Devolve métricas para chamadas API com códigos de estado de resposta entre 400 e 599:
filter=(response_status_code ge 400 and response_status_code le 599)
Devolve métricas para chamadas API com o código de estado da resposta 200 e um código de resposta de destino de
404:
filter=(response_status_code eq 200 and target_response_code eq 404)
Devolve métricas para chamadas API com um código de estado da resposta de 500:
filter=(response_status_code eq 500)
Devolve métricas para chamadas da API que não resultaram em erros:
filter=(is_error eq 0)
Devolve métricas para chamadas API que não resultaram em respostas null:
filter=(response_status_code isnot null)
Seguem-se os operadores que pode usar para criar filtros de relatórios.
| Operador | Descrição |
|---|---|
in |
Incluir na lista |
notin |
Excluir da lista |
is |
Use response_status_code is null para filtrar respostas cujo código de estado seja null. |
isnot |
Use response_status_code isnot null para filtrar respostas cujo código de estado não seja null. |
eq |
É igual a == |
ne |
Diferente de != |
gt |
Maior que > |
lt |
Inferior a < |
ge |
Maior ou igual a >= |
le |
Menor ou igual a <= |
like |
Devolve true se o padrão de string corresponder ao padrão fornecido. |
not like |
Devolve falso se o padrão de string corresponder ao padrão fornecido. |
similar to |
Devolve verdadeiro ou falso consoante o respetivo padrão corresponder à string fornecida. É semelhante a like, exceto que interpreta o padrão usando a definição de uma expressão regular da norma SQL. |
not similar to |
Devolve falso ou verdadeiro consoante o respetivo padrão corresponder à string fornecida. É semelhante a not like, exceto que interpreta o padrão usando a definição de uma expressão regular da norma SQL. |
and |
Permite usar a lógica AND para incluir mais do que uma expressão de filtro. O filtro
inclui dados que cumprem todas as condições. |
or |
Permite-lhe usar a lógica OR para avaliar diferentes expressões de filtro possíveis. O filtro
inclui dados que cumprem, pelo menos, uma das condições. |