Free trial

Apigee Edge

Prerequisites

  • APIs hosted on Apigee Edge Cloud
    • API Edge for Private Cloud is not supported at this time
  • An Environment ActiveGate that has the ActiveGate plugin module installed and isn't used for synthetic or mainframe monitoring
    • 1 environment ActiveGate can typically support 30-50 API endpoints

Interested in monitoring your APIs hosted on Apigee Edge with DESK?

The Apigee Edge ActiveGate extension is available as a Preview. To enroll, contact a DESK ONE product specialist by clicking the chat button in the upper-right corner of the DESK menu bar.

Environment ActiveGate installation

ActiveGate plugin module installation

ActiveGate version 1.175+ has the plugin module installed by default.

Extension installation

  1. Obtain the install file (custom.remote.python.apigee.zip). Don't rename the file.

  2. Unzip custom.remote.python.apigee.zip to the plugin_deployment directory of your ActiveGate host.

  3. If the resulting directory structure isn't .\plugin_deployment\custom.remote.python.apigee\, please make the neccessary changes.

  4. Restart the DESK Remote Plugin Module service.

    • On Linux, restart the service using the following commands with admin rights:
      • systemctl restart remotepluginmodule.service
    • On Windows, run these two commands in a Command Prompt launched as Admin:
      • sc stop "DESK Remote Plugin Module"
      • sc start "DESK Remote Plugin Module"

  5. Return to the DESK web UI. Click Settings, the Add new technology monitoring button, and finally the Add ActiveGate plugin button.

  6. Click the Upload plugin button and upload custom.remote.python.apigee.zip.

  7. Enter the endpoint information requested for connecting to the API endpoint:

    • Endpoint name: Type a meaningful endpoint name.
    • User: User or e-mail associated with the organization account. If using SAML Authentication, you must request a machine user from Apigee and once received, you must log-in at least once before using it in the plugin configuration. The first time you use a machine user, it will prompt you to change your password.
    • Authentication method: Basic Authentication, OAuth2 token, SAML (requires machine user from Apigee).
    • SAML zone: When SAML Authentication is selected, you must enter a zone name to your retrieve the initial token.
    • Apigee account organization: The name of the account from which the plugin will retrieve Performance metrics.
    • Environment: Test, Dev, Prod, etc. Select the environment for which you would like to collect metrics.
    • Comma separated proxies: A list of up to 100 proxy names, or leave blank to retrieve the first 100 proxies.
    • Top 100: Choose the criteria for selecting top 100 proxies.
    • HTTP Proxy Host:Port: If you need to use a proxy to communicate out to Apigee Edge, enter the host:port in this field.
    • HTTP Proxy User: If you use Basic Authentication to use the HTTP Proxy, enter the username in this field.
    • HTTP Proxy Password: If you use Basic Authentication to use the HTTP proxy, enter the password for the user provided here.

    Apigee Edge

Troubleshoot ActiveGate plugins

Metrics

The following metrics are captured by the extension:

Proxy

  • Traffic
  • Throughput
  • Errors
  • Cache hits
  • Target errors
  • Total response time
  • Target response time
  • Request size
  • Response size
  • Request processing latency
  • Response processing latency

Target

  • Traffic
  • Throughput
  • Errors
  • Response time
  • Request size
  • Response size
  • Request processing latency
  • Response processing latency