(apigateway): get metrics from a resource

With API GW CDK it is possible today to easily get metrics at the RestAPI level like this:

RestApi restApi = new RestApi(...);
...
restApi.metricLatency();
restApi.metricServerError();
restApi.metricCount();

This is super useful. These metrics are provided by default with API GW. It is possible to get metrics at the resource level if you enable advanced Cloudwatch Metrics on the API. It would be great if we could have similar methods at the Resource level.

Use Case

If an organization uses one API Gateway RestApi with many resources in it each linked to a unique integrations then the API level metrics are not very useful. When the metrics present a problem then it is unclear which specific resource/integration is the cause of it. Being able to easily get these metrics at the resource level would resolve this.

Proposed Solution

IResource resource = new Resource(..);
...
resource.metricLatency();
resource.metricServerError();
resource.metricCount();

Other

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[humanzz]

This is something I’ve also been looking for. Just adding to @nija-at’s comment, the dimensions for this sort of metric also include Method so in total they are ApiName, Method, Resource, Stage which might mean the method needs to be passed in as well.

[nija-at]

Ok. I’m adding this to our backlog.

I’m marking this as p2 which means we are unable to get to this right away. Happy to accept pull requests if you would like this feature in earlier.