Como fazer o upload de dados de tráfego da API para a Apigee: versão Beta

Edge for Private Cloud v. 4.16.09

Todos os clientes do Edge para nuvem privada precisam enviar para a Apigee as estatísticas sobre APIs o tráfego de proxy. A Apigee recomenda que os clientes façam upload dessas informações uma vez por dia, possivelmente até criar um cron job.

Você precisa enviar os dados para suas implantações de API de produção, mas não para APIs em desenvolvimento. ou teste de implantações. Na maioria das instalações do Edge, você define organizações ou ambientes para suas APIs de produção. Os dados que você enviar são destinados somente à produção organizações e ambientes.

Para ajudar no upload desses dados, a Apigee oferece a versão Beta da linha de comando apigee-analytics-collector. utilitário. Esse utilitário envia o relatório de volume de chamadas de API de volta à Apigee. Todas as bordas da A instalação da nuvem privada pode usar esse utilitário para recuperar e relatar dados de tráfego para a Apigee.

Para mais informações sobre o processo de upload de dados de tráfego para a Apigee, consulte a Perguntas frequentes.

Como instalar o apigee-analytics-collector

O apigee-analytics-collector é um módulo Node.js que pode ser instalado usando npm.

Instalação requisitos

O apigee-analytics-collector o utilitário exige:

• npm 2.x ou mais recente
• Node.js 4.x

Onde instalar

O nó em que você instala o utilitário apigee-analytics-collector pode ser qualquer nó que pode acessar a API de gerenciamento de borda no servidor de gerenciamento de borda. Você pode instalá-lo diretamente no servidor de gerenciamento, em outro nó da instalação do Edge ou em um desde que ele possa fazer solicitações de API ao servidor de gerenciamento.

Acesso à Internet requisitos

Instale o utilitário apigee-analytics-collector em uma máquina virtual com acesso externo à Internet. Em seguida, o utilitário apigee-analytics-collector poderá fazer upload diretamente para a Apigee.

Se não houver um nó com acesso à API de gerenciamento de borda no servidor de gerenciamento de borda e com acesso externo à Internet, é possível usar a API Edge Management para economizar os dados localmente. Em seguida, você deve transferir os dados para uma máquina com acesso à Internet para upload para a Apigee. Nesse caso, não é necessário usar o utilitário apigee-analytics-collector. Consulte Como fazer upload manual de dados para a Apigee abaixo para mais informações.

Instalação

Use o seguinte comando para instalar o utilitário apigee-analytics-collector:

> npm install apigee-analytics-collector -g

Como executar o apigee-analytics-collector

Nesta seção, descrevemos como executar o utilitário apigee-analytics-collector.

Informações necessárias para executar o apigee-analytics-collector

Você precisa das seguintes informações para executar o comando apigee-analytics-collector e encaminhar dados para a Apigee:

• apigee_mgmt_api_uri: o URL base da API Edge na sua instância Servidor. Esse URL geralmente tem o seguinte formato:
  http://ms_IP:8080/v1
  
  em que ms_IP é o endereço IP ou seu servidor de gerenciamento e 8080 é a porta usada pela API Edge. Se você criou uma entrada DNS para a API Edge, o URL está em o formulário:
  http://ms_DNS/v1
  
  Se você ativar o TLS na API Edge Management, ele estará no seguinte formato:
  https://ms_IP:8080/v1
  https://ms_DNS/v1
• apigee_mgmt_api_email: o endereço de e-mail de uma conta com acesso ao APIs /stats do Edge Muitas vezes, será o e-mail do administrador do sistema de Edge ou o e-mail do administrador da organização para suas organizações de produção.
• apigee_mgmt_api_password: a senha do Edge para a conta especificada pelo apigee_mgmt_api_email.
• apigee_analytics_client_id e apigee_analytics_secret: Suas credenciais para fazer upload de dados para a Apigee. Envie um tíquete pelo suporte da Apigee para receber apigee_analytics_client_id e apigee_analytics_secret.

Exemplos de comandos

Veja abaixo um exemplo de comando para recuperar dados de tráfego de todas as organizações e ambientes na instalação do Edge e faça upload desses dados para a Apigee:

> apigee-analytics-collector export traffic \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

O comando contém todas as informações necessárias, como apigee_analytics_client_id e apigee_analytics_secret.

Os resultados vão aparecer no formulário:

[
  {
    "org": "myOrg",
    "env": "prod",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  },
  {
    "org": "VALIDATE",
    "env": "test",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  }
]

Use as opções de linha de comando para controlar as ações do comando. Use as seguintes opções para especificar as organizações e os ambientes a serem incluídos nos dados gerados:

• -i, --include_orgs (em inglês) <lista de itens separada por vírgulas>
• -x, --exclude_orgs <lista de itens separada por vírgulas>
• -n e --include_envs <lista de itens separada por vírgulas>
• -e, --exclude_envs <lista de itens separada por vírgulas>

Por exemplo, para especificar apenas as organizações e os ambientes de produção, use o método Opções -i (ou --include_orgs) e -n (ou --include_envs):

> apigee-analytics-collector export traffic -i myOrg -n prod \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

Neste exemplo, você coleta dados apenas do ambiente de produção do myOrg.

Para despejar os dados em uma tela e analisá-los antes de enviá-los à Apigee, use a opção -S:

> apigee-analytics-collector export traffic -i myOrg -n prod -S \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

A opção -S omite os dados para a Apigee. Em seguida, execute novamente o comando sem a opção -S para enviar os dados à Apigee.

Um motivo para usar o -S é possível exibir diferentes tipos de dados localmente. A Apigee exige apenas que você enviar dados de tráfego da API, mas a opção -D permite exibir dados sobre a API desenvolvedores, apps ou proxies de API. O exemplo abaixo usa as opções -D e -S para exibir dados do desenvolvedor localmente:

> apigee-analytics-collector export traffic -i myOrg -n prod -S -D devs \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

Inclua a opção -v para receber a saída detalhada e a opção -R para ver os comandos curl gerados pelo apigee-analytics-collector:

 > apigee-analytics-collector export traffic -i myOrg -n prod -S -R -v \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

A próxima seção contém uma lista completa de opções de linha de comando.

Parâmetros de comando

A tabela a seguir lista o conjunto completo de opções para o apigee-analytics-collector utilitário:

Como fazer upload manual de dados para a Apigee

A Apigee recomenda que você instale o utilitário apigee-analytics-collector em uma máquina virtual com acesso externo à Internet. Em seguida, o utilitário apigee-analytics-collector poderá fazer upload diretamente para a Apigee.

No entanto, se a máquina não tiver acesso externo à Internet, use a API Edge Management para coletar dados de tráfego e usar comandos cURL para fazer upload deles para a Apigee de uma máquina com à Internet. É preciso repetir esse processo para cada organização de produção e na sua instalação do Edge.

Use o comando cURL a seguir para coletar dados de tráfego de uma organização específica e ambiente para um intervalo de tempo especificado:

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://<ms_IP>:8080/v1/organizations/{org_name}/environments/{env_name}/stats/?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM"

Esse comando usa a API de contagem de mensagens da API Edge Get. Nesse comando:

• apigee_mgmt_api_email:apigee_mgmt_api_password especifica: Endereço de e-mail de uma conta com acesso às APIs Edge /stats.
• &lt;ms_IP&gt; é o endereço IP ou nome DNS do Edge Management Server.
• {org_name} e {org_name} especificam os organização e ambiente.
• MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM especifica o período de as estatísticas a serem coletadas. O comando cURL usa o código hexadecimal %20 para os espaços no período.

Por exemplo, para coletar estatísticas para um período de 24 horas, use o seguinte comando:

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/?select=sum(message_count)&timeRange=08/29/2016%2000:00~08/30/2016%2000:00"

Você verá uma resposta no formato:

{
  "environments" : [ {
    "metrics" : [ {
      "name" : "sum(message_count)",
      "values" : [ "42.0" ]
    } ],
    "name" : "prod"
  } ],
  "metaData" : {
    "errors" : [ ],
    "notices" : [ "query served by:53dab80c-e811-4ba6-a3e7-b96f53433baa", "source pg:6b7bab33-e732-405c-a5dd-4782647ce096", "Table used: myorg.prod.agg_api" ]
  }
}

Para fazer upload desses dados na Apigee usando uma máquina com acesso à Internet, use o cURL a seguir. comando:

curl -X POST -H 'Content-Type:application/json' \
-u apigee_analytics_client_id:apigee_analytics_secret \
https://nucleus-api-prod.apigee.com/v1/apigee-analytics-cli-api/traffic/orgs/{org_name}/apis -d '{"environments"...}'

em que:

• apigee_analytics_client_id:apigee_analytics_secret especifique seu credenciais para fazer upload de dados para a Apigee que você recebeu do suporte da Apigee.
• {org_name} especifica a organização.
• {"environments"...} contém os resultados do comando cURL que que você usou para coletar as estatísticas acima.