Building an API platform on AWSInsights3 min

You can group the insights into two broad categories - operational and business. Depending on your focus area, you could use different approaches to gain the information needed.

Operational insights

For operational insights, you can use Amazon CloudWatch. Note, that Amazon CloudWatch expanded capabilities to unify and manage log data across operational, security, and compliance use cases with flexible and powerful analytics in one place and with reduced data duplication and costs. See blog post for more details.

CloudWatch Logs Insights enables you to interactively search and analyze your log data in Amazon CloudWatch Logs. You can perform queries to help you more efficiently and effectively respond to operational issues. Find code snippets for the API Gateway log queries at Serverless Land.

Logs Insights API Gateway

Operational insights often require visibility into the entire application stack, not just the API. Amazon CloudWatch Application Insights helps with observability for your applications and underlying AWS resources. Application Insights provides automated dashboards that show potential problems with monitored applications, which help you quickly isolate ongoing issues with your applications and infrastructure.

You can use Contributor Insights to analyze log data and create time series that display contributor data. You can see metrics about the top-N contributors, the total number of unique contributors, and their usage. This helps you find top talkers and understand who or what is affecting system performance. AWS Management Console has API Gateway specific sample rules for various insights:

Contributor Insights API Gateway rules

DIY solutions

You can extend "out of the box" insights using analytics services such as Amazon Athena or Amazon Glue for the initial log processing and enrichment. Use Amazon QuickSight or Amazon OpenSearch Service for querying and visualization. See links to the sample implementations of usage plans and log analytics in the sidebar.

Business insights

For business insights, build custom queries and visualizations using tools listed in the previous sections:

Usage plans utilization

Also, you can use AWS partner solutions like Moesif for business reports and dashboards.

Partner solutions

For the insights, you would typically use observability solutions by AWS partners listed in the Monitor lesson. Some of them provide API Gateway specific insights as well:

Select a partner solution based on the insights type you are looking for - business/operational focus often depends on the solution.


Created by:

Arthi Jaganathan
Arthi JaganathanArthi is a Principal Serverless Solutions Architect who works closely with customers in ASEAN. She is passionate about Serverless and developer tooling.
Giedrius Praspaliauskas
Giedrius PraspaliauskasGiedrius is a senior solutions architect focusing on serverless at Amazon Web Services based in the US.