How to check APIGEE SAAS Environment Health status

Former Community Member
Not applicable

Hi,

Is there a set of Custom reports or anything in the Management APIs that I can use everyday to check the health of our APIGEE Prod Environment (SAAS)?

Purpose: The need is to run a report or view a dashboard to check if everything is working as expected.

For example:

1. If the environment is offline

2. If any of the proxies is offline/unreachable

3. If the Dev Portal is offline

It would help if someone can share how other organizations are doing this daily check on their APIGEE SAAS setup.

Thanks in advance!

0 2 449
2 REPLIES 2

Apigee doesn't include a proactive endpoint monitoring service (although it's an intriguing feature idea). There are third parties that provide such a service . Or you could build one yourself, inexpensively, by setting up a cron job (or in Windows, a scheduled task), or a cloud-based scheduled task via something like Google Cloud Scheduler.

Regardless of where you configure it to run, the task should ping the various endpoints of interest (mgmt api, your own APIs, devportal, etc) and report back a result to ... something. like maybe a Slack room or whatever you use. To support this you'd want to expose a healthcheck API in each of your proxies that is idempotent and responds with "200 OK" when pinged.

You'd be responsible for writing the code to send out the http requests and evaluate the responses, and then form the "report" and post it somewhere.

Within Apigee there is an "API Monitoring" feature, which does some of what you want. It focuses on monitoring your own custom APIs, but does not monitor devportals or the Apigee management API. You can configure various alert conditions, including

  • the number of requests (low or high)
  • error rates exceeding thresholds
  • latency exceeding thresholds

The API monitoring feature in Apigee doesn't actively "ping" any endpoints; instead it relies on the results of analytics data for APIs under management.

For more on the API Monitoring feature, start here.

Former Community Member
Not applicable

Thank you Dino. Will look into API Monitoring.