apigee-analytics-collector

This is a commandline utility to send the API call volume report back to Apigee. Any Edge Private Cloud installation could use this utility. apigee-analytics-collector internally leverages Edge Management APIs to retrieve and report data to Apigee.

Installation

apigee-analytics-collector is a Node.js module and you can install it using npm.

Requirements

npm 2.x or greater and Node.js 4.x.

The following information is required to forward traffic data to Apigee:

1. apigee_mgmt_api_uri This can be obtained from your Apigee Administrator e.g. https://{hostname}/v1
2. apigee_mgmt_api_email This account requires access to open /stats api
3. apigee_mgmt_api_password
4. apigee_analytics_client_id please submit a ticket with Apigee Support to obtain apigee_analytics_client_id and apigee_analytics_secret
5. apigee_analytics_secret

Installation using npm

npm install apigee-analytics-collector -g

Use beta tag for influx features, so npm install apigee-analytics-collector@beta -g

NOTE: The -g option places the apigee-analytics-collector command in your PATH. On "*nix"-based machines, sudo may be required with the -g option. If you do not use -g, then you need to add the apigee-analytics-cli command to your PATH manually. Typically, the -g option places modules in: /usr/local/lib/node_modules/apigee-analytics-cli on *nix-based machines.

Parameters

```bash` $ apigee-analytics-collector export traffic --help

Usage: apigee-analytics-collector-export-traffic [options]

Export data from the management API

Options:

-h, --help                                                     output usage information
-E, --select                                   Return metrics in a single request e.g. sum(message_count),avg(total_response_time). More info https://goo.gl/fv69d2. Default sum(message_count)
-D, --dimension                                     The traffic dimension to collect. Valid dimensions: apiproducts, devs, apps, apiproxy(default)
-d, --days                                               The number of days to collect in retrograde. 3 by default
-m, --apigee_mgmt_api_uri                 URL to management API
-u, --apigee_mgmt_api_email             Email registered on the Management API. See .env file to setup default value
-p, --apigee_mgmt_api_password       Password associated to the management api email account
-T, --apigee_mgmt_token                     Token generated by Apigee Edge Management API. Learn more https://goo.gl/8PrIZ4.
-i, --include_orgs                                      Include orgs from this list (comma separated) 
-x, --exclude_orgs                                      Exclude orgs from this list (comma separated)
-n, --include_envs                                      Include environments from this list (comma separated) 
-e, --exclude_envs                                      Exclude envs from this list (comma separated)
-o, --output