Conferir o uso de recursos de Pagamento por uso

Esta página se aplica à Apigee, mas não à Apigee híbrida.

Confira a documentação da Apigee Edge.

Há várias ferramentas que podem ser usadas para visualizar e monitorar o uso de recursos da Apigee. Neste tópico, falamos sobre como os administradores de faturamento ou organização podem fazer o seguinte:

Para ver o uso de recursos da organização e configurar alertas, você precisa dos seguintes papéis:

  • Administrador da organização da Apigee (roles/apigee.admin)
  • Visualizador de registros ((roles/logging.viewer)
  • Leitor da conta de faturamento (roles/billing.viewer)

Ver o uso de recursos no Metrics Explorer

Use o Metrics Explorer para ver o uso dos recursos da Apigee que são importantes para determinar o custo no plano de preços de pagamento por uso. Ao selecionar métricas e filtros específicos, é possível gerar um relatório de uso para unidades de implantação de fluxo compartilhado/proxy de Apigee, ambientes ativos da Apigee ou ambos.

Para informações detalhadas sobre as métricas da Apigee e os possíveis valores delas, consulte apigee na página de métricas do Google Cloud.

Uso da unidade de implantação de proxy/fluxo compartilhado da Apigee

Interface do Metrics Explorer

Para ver o uso da unidade de implantação de proxy/fluxo compartilhado da Apigee no Metrics Explorer, siga estas etapas:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. No painel Selecionar uma métrica, expanda o menu Métrica e insira Apigee na barra de filtro.

    Use os submenus para selecionar o tipo, a categoria e a métrica do recurso:

    1. No menu Recursos ativos, selecione Proxy da Apigee (v2).
    2. No menu Categorias de métricas ativas, selecione Proxyv2.
    3. No menu Métricas ativas, selecione Detalhes do proxy da Apigee.
  3. Clique em Aplicar.
  4. Na seção Filtros:
    1. Use o menu Agrupar por para agrupar por identificador de recurso. Selecione proxy_deployment_type e env nas opções da lista para fazer o agrupamento por tipo de implantação de proxy e ambiente.
    2. Clique em OK para aplicar os filtros.
  5. Selecione Contagem no menu Função de agrupamento.

MQL

Para ver o uso da unidade de implantação de proxy/fluxo compartilhado da Apigee com uma consulta MQL, faça o seguinte:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. Na barra de ferramentas do painel Selecionar uma métrica, clique em Editor de código.
  3. Para usar o MQL:
    1. Selecione MQL no botão de alternância MQL.
    2. Digite esta consulta no editor de consultas: 
      fetch apigee.googleapis.com/ProxyV2
| metric 'apigee.googleapis.com/proxyv2/details'
| group_by [metric.proxy_deployment_type, resource.env]

PromQL

Para ver o uso da unidade de implantação de proxy/fluxo compartilhado da Apigee com uma consulta PromQL, faça o seguinte:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. Na barra de ferramentas do painel Selecionar uma métrica, clique em Editor de código.
  3. Para usar o PromQL:
    1. Selecione PromQL no botão de alternância PromQL.
    2. Digite esta consulta no editor de consultas: 
      count(apigee_googleapis_com:proxyv2_details{monitored_resource="apigee.googleapis.com/ProxyV2"}) by (proxy_deployment_type, env)

Uso do ambiente ativo da Apigee

Interface do Metrics Explorer

Para ver o uso do ambiente ativo da Apigee no Metrics Explorer, siga estas etapas:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. No painel Selecionar uma métrica, expanda o menu Métrica e insira Apigee na barra de filtro.

    Use os submenus para selecionar o tipo, a categoria e a métrica do recurso:

    1. No menu Recursos ativos, selecione Ambiente da Apigee.
    2. No menu Categorias de métrica ativas, selecione Ambiente.
    3. No menu Métricas ativas, selecione Ambiente ativo da Apigee.
  3. Clique em Aplicar.
  4. Na seção Filtros:
    1. Use o menu Agrupar por para agrupar por identificador de recurso. Selecione type nas opções da lista para fazer o agrupamento por tipo de ambiente.
    2. Clique em OK para aplicar os filtros.
  5. Selecione Contagem no menu Função de agrupamento.

MQL

Para ver o uso do ambiente ativo da Apigee com uma consulta MQL, faça o seguinte:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. Na barra de ferramentas do painel Selecionar uma métrica, clique em Editor de código.
  3. Para usar o MQL:
    1. Selecione MQL no botão de alternância MQL.
    2. Digite esta consulta no editor de consultas: 
      fetch apigee.googleapis.com/Environment
| metric 'apigee.googleapis.com/environment/active'
| group_by [metric.type, resource.env]

PromQL

Para ver o uso do ambiente ativo da Apigee com uma consulta PromQL, faça o seguinte:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. Na barra de ferramentas do painel Selecionar uma métrica, clique em Editor de código.
  3. Para usar o PromQL:
    1. Selecione PromQL no botão de alternância PromQL.
    2. Digite esta consulta no editor de consultas: 
      count(apigee_googleapis_com:environment_active{monitored_resource="apigee.googleapis.com/Environment"}) by (env, type)

Chamadas de API padrão e extensíveis

Interface do Metrics Explorer

Para visualizar chamadas de API padrão e extensíveis por ambiente no Metrics Explorer, use as seguintes etapas:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. No painel Selecionar uma métrica, expanda o menu Métrica e insira Apigee na barra de filtro.

    Use os submenus para selecionar o tipo, a categoria e a métrica do recurso:

    1. No menu Recursos ativos, selecione Ambiente da Apigee.
    2. No menu Categorias de métrica ativas, selecione Ambiente.
    3. No menu Métricas ativas, selecione Contagem de chamadas da API do ambiente da Apigee.
  3. Clique em Aplicar.
  4. Na seção Filtros:
    1. Use o menu Agrupar por para agrupar por identificador de recurso. Selecione proxy_deployment_type nas opções da lista para fazer o agrupamento por tipo de ambiente.
    2. Clique em OK para aplicar os filtros.
  5. Selecione Soma no menu Função de agrupamento.

MQL

Para visualizar chamadas de API padrão e extensíveis por ambiente com uma consulta MQL:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. Na barra de ferramentas do painel Selecionar uma métrica, clique em Editor de código.
  3. Para usar o MQL:
    1. Selecione MQL no botão de alternância MQL.
    2. Digite esta consulta no editor de consultas: 
      fetch apigee.googleapis.com/Environment
| metric 'apigee.googleapis.com/environment/api_call_count'
| delta(1m)
| group_by [metric.proxy_deployment_type, resource.env, resource.location]

PromQL

Para visualizar chamadas de API padrão e extensíveis por ambiente com uma consulta PromQL:

  1. Abra a página Monitoramento > Metrics Explorer no console do Google Cloud.

    Acessar o Metrics Explorer

  2. Na barra de ferramentas do painel Selecionar uma métrica, clique em Editor de código.
  3. Para usar o PromQL:
    1. Selecione PromQL no botão de alternância PromQL.
    2. Digite esta consulta no editor de consultas: 
      sum(delta(apigee_googleapis_com:environment_api_call_countmonitored_resource="apigee.googleapis.com/Environment"}[1m])) by (proxy_deployment_type,env,location)

Criar um painel de métricas

A saída gráfica do Metrics Explorer na guia Gráfico representa uma métrica de medidor. Isso significa que cada ponto no gráfico registra a utilização de recursos da instância da Apigee em todos os ambientes de cada região no momento da medição.

Depois de configurar a visualização dos dados usando a seleção Recurso e métrica, salve os dados em um painel personalizado para referência futura. Para salvar a visualização selecionada, faça o seguinte:

  1. Clique no botão Salvar gráfico no painel do gráfico da guia Explorador.
  2. Na caixa de diálogo Salvar gráfico, insira as seguintes informações:
    • Título do gráfico: digite um nome para o gráfico ou use o título sugerido.
    • Menu suspenso Painel: selecione um painel atual ou Novo painel para criar e nomear um novo painel. Seu gráfico vai ser salvo no painel selecionado.
  3. Clique em Salvar.

Depois de salvar, acesse seu gráfico na página Visão geral dos painéis no console do Google Cloud e visualize o painel selecionado.

Para saber mais sobre como criar e gerenciar visualizações personalizadas usando o Cloud , consulte Painéis e gráficos.

Configurar um alerta do Cloud Monitoring

Depois de configurar os relatórios de métricas para o uso de recursos da Apigee no Cloud Monitoring, é possível ativar políticas de alertas baseadas em métricas. É possível configurar políticas de alertas para monitorar o uso de recursos relevantes para o seu plano de pagamento por uso e receber informações sobre possíveis problemas em tempo hábil. Para mais informações, consulte Como funcionam os alertas.

É possível adicionar uma política de alertas baseada em métrica ao seu projeto do Google Cloud usando o console do Google Cloud, a API Cloud Monitoring ou a Google Cloud CLI. Com o console do Google Cloud, é possível ativar os alertas recomendados ou configurar alertas personalizados na página Alertas do Cloud Monitoring.

Veja etapas gerais para criar uma política de alertas baseada em métricas em Criar políticas de alertas de limite de métrica. Para configurar uma política de alertas especificamente com base no uso de recursos, siga as etapas em Criar uma política de alertas.

É possível usar as mesmas métricas e os mesmos filtros da seção anterior para personalizar seu alerta de uso de recursos. Por exemplo, para criar um alerta com base no uso do proxy da Apigee, siga estas etapas:

  1. Abra a página Monitoramento > Alertas no console do Google Cloud.

    Acessar o alerta

  2. Clique em + Criar política.
  3. Na seção Selecionar uma métrica do painel Criar política, insira Apigee na barra de filtros e, em seguida, use os submenus para selecionar o tipo de recurso. categoria e métrica:
    • No menu Recursos ativos, selecione Proxy da Apigee (v2).
    • No menu Categorias de métricas ativas, selecione Proxyv2.
    • No menu Métricas ativas, selecione Detalhes do proxy da Apigee.
  4. Na seção Adicionar filtros, use o menu Agrupar por para agrupar por rótulo de recurso. Selecione proxy_deployment_type e env nas opções da lista para fazer o agrupamento por tipo de implantação de proxy e ambiente.

Para criar um alerta com base no uso do ambiente ativo da Apigee, selecione as métricas e os filtros usados em Ver o uso do ambiente da Apigee.

Ver o uso de recursos por conta de faturamento

Para ver o uso de recursos por conta de faturamento, siga estas etapas:

  1. Abra a página Faturamento no console do Google Cloud.

    Acessar Faturamento

  2. Se você tiver mais de uma conta de faturamento, selecione Acessar a conta de faturamento vinculada para ver a conta de faturamento do projeto atual. Para localizar outra conta, selecione Gerenciar contas de faturamento e escolha aquela que você quer visualizar.
  3. Selecione relatórios
  4. Se o menu Filtros ainda não estiver aberto, clique em Mostrar filtros para acessá-lo.
  5. No campo Período, selecione Data de uso para ver um resumo do faturamento atual em um período. Se preferir, selecione Mês da fatura para ver o uso faturado em uma fatura específica.
  6. Selecione Agrupar por > SKU.
  7. Na lista suspensa Serviços, selecione Apigee. A lista de SKUs incluídas na fatura é exibida.
  8. Para filtrar a lista de SKUs, selecione aquelas que você quer visualizar na lista suspensa SKUs.

    Se o uso de qualquer uma dessas SKUs for 0, ela não aparecerá no menu suspenso Agrupar por > SKU.

Monitorar o uso de recursos com o Registros de auditoria do Cloud

Use os Registros de auditoria do Cloud para monitorar o uso de recursos que afetarão seu faturamento de pagamento por uso. Siga estas etapas para ver os registros de auditoria relevantes:

  1. Abra a página da Análise de registros no console do Cloud.

    Acessar o Explorador de registros

  2. Em Consulta, use a barra de pesquisa para procurar eventos que afetam os seguintes recursos faturáveis:
    • Crie uma instância com ambientes anexados: google.cloud.apigee.v1.InstanceService.CreateInstanceAndAttachments
    • Atualize a instância e os anexos dela: google.cloud.apigee.v1.InstanceService.UpdateInstanceAndAttachments
    • Exclua a instância com ambientes anexados: google.cloud.apigee.v1.InstanceService.DeleteInstance
    • Crie o anexo da instância: google.cloud.apigee.v1.InstanceAttachmentService.CreateInstanceAttachment
    • Exclua o anexo da instância: google.cloud.apigee.v1.InstanceAttachmentService.DeleteInstanceAttachment
    • Implante um proxy: google.cloud.apigee.v1.DeploymentService.DeployApiProxy
    • Cancele a implantação de um proxy: google.cloud.apigee.v1.DeploymentService.UndeployApiProxy
    • Implante um fluxo compartilhado: google.cloud.apigee.v1.DeploymentService.DeploySharedFlow
    • Cancele a implantação de um fluxo compartilhado: google.cloud.apigee.v1.DeploymentService.UndeploySharedFlow
    • Ativar/desativar o complemento Apigee API Analytics ou Segurança avançada da API: google.cloud.apigee.v1.EnvironmentAddons.SetAddonEnablement

    Por exemplo, você pode inserir a seguinte consulta de exemplo: 

    resource.type="audited_resource"
resource.labels.method="google.cloud.apigee.v1.InstanceService.CreateInstanceAndAttachments"
resource.labels.service="apigee.googleapis.com"

    Para mais informações sobre como usar os Registros de auditoria do Cloud para monitorar os recursos da Apigee, consulte Informações sobre o registro de auditoria da Apigee.