Apigee Edge

Learn how to monitor APIs that are hosted in Apigee Edge using the Dynatrace ActiveGate extension for Apigee Edge.

Getting started

To get started, just click the chat button in the upper-right corner of the Dynatrace menu bar to contact a Dynatrace ONE Product Specialist. Dynatrace ONE will make sure you have what you need to monitor 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.
    • ActiveGate version 1.175+ is ready to accept and run plugins. If you are running an earlier version of ActiveGate, see the Install ActiveGate plugin module instructions.
    • For Environment ActiveGate installation instructions, see Dynatrace ActiveGate.
    • One environment ActiveGate can typically support 30-50 API endpoints.

Extension installation

After the extension has been added to your license

  1. Get the install file (custom.remote.python.apigee.zip) from your Dynatrace ONE Product Specialist via live chat. 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 necessary changes.

  4. Restart the Dynatrace 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 "Dynatrace Remote Plugin Module"  
      sc start "Dynatrace Remote Plugin Module"  
      
  5. In Dynatrace, select Settings, Add new technology monitoring, and Add ActiveGate plugin.

  6. Select Upload plugin and upload custom.remote.python.apigee.zip.

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

    Setting Details
    Endpoint name Enter a meaningful endpoint name.
    User User or email associated with the organization account. If you are using SAML Authentication, you must request a machine user from Apigee and you must use it at least once to log in 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 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 API proxies A list of up to 100 proxy names, or leave blank to retrieve the first 100 proxies.
    Top 100 by Choose the criteria for selecting the 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.

Troubleshoot ActiveGate plugins

See 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