After you’ve created and published your API, you can configure your analytics and notifications. Learn more about the different aspects of the APIM console.
You can configure Platform, API, or Application dashboards. You can review dashboards in the console Dashboard in the left-most navigation menu and API-specific dashboards under your API → Analytics.
-
Navigate to your console Settings in the left-hand menu.
-
Under the Portal heading, click Analytics.
-
Click Add a new dashboard and enter your dashboard details, including an optional query filter.
-
Click the + at the bottom right-hand side of the screen to add a new widget.
-
You can configure many widgets, including tables, line or pie charts, graphs, maps, or statistics.
-
Select your field or use custom fields for your widgets.
-
Click Save.
-
Click Enable preview to review your dashboard, or simply check Enable dashboard to make your dashboard live.
A health check is a mechanism to monitor the availability and health of your endpoints and/or API Gateways. You can configure health checks for both endpoints and API Gateways. Like load-balancing and failover, health checks are backend services. To ensure that you are prepared to use health checks, make sure that you are familiar with the following concepts:
-
Trigger: define what triggers the health checks.
-
HTTP methods
-
Paths
-
Headers
-
-
Schedule: the schedule at which health checks can be triggered. These can be configured in seconds, minutes, hours, days, weeks, months, and years.
-
From root path: enable this to apply the specified path at the root URL level. For example, if your endpoint URL is
www.test.com/api, this option removes/apibefore appending the path. -
Assertions: where you specify any specific conditions to test for in the API response that will trigger a health check. Assertions are written in Expression Language. An assertion can be a simple
200response (#response.status == 200), but you can also test for specific content.
After configuring health checks, you can view health check information and results in the Health-check dashboard for that specific API. Here, you have multiple charts to track:
-
Global availability: average availability and average response times for all health-checked endpoints.
-
Per-endpoint availability: average availability and average response times for specific endpoints.
-
Per-gateway availability: average availability and response times per API Gateway where health-check is enabled.
-
Latest check: a running list of the most recent health checks. You can choose to show only status transitions.
You can enable logs at the API level. Use logging with caution and only for development purposes. It requires more space for analytics storage and can impact API performance.
-
Navigate to your API → Logs.
-
Click Configure the logging.
-
Choose your logging, content, and scope modes.
Enable notifications at the API or system level.
-
Navigate to your API → Notifications settings.
-
Click + Add notification at the upper right-hand corner of your screen.
-
Configure your notification settings by API key, Subscription, Support, Lifecycle, Rating, or Review.
-
Navigate to your API → Notifications settings.
-
Click the Trashcan to the right of the specific notification you want to delete.
-
Confirm that you want to delete the notification.
Comments
Article is closed for comments.