Skip to content

fix(apigatewayv2): incorrect metric names for client and server-side errors#14541

Merged
mergify[bot] merged 1 commit intomasterfrom
nija-at/apigwv2-metric-names
May 5, 2021
Merged

fix(apigatewayv2): incorrect metric names for client and server-side errors#14541
mergify[bot] merged 1 commit intomasterfrom
nija-at/apigwv2-metric-names

Conversation

@nija-at
Copy link
Copy Markdown
Contributor

@nija-at nija-at commented May 5, 2021

In the HTTP API offering of API Gateway, the metric names for
client-side and server-side errors are '4xx' and '5xx'.

This was incorrectly configured as '4XXError' and '5XXError' which is
the metric name in the REST API offering.

fixes #14503

In addition, a previous change elevated metrics defined in HTTP API such
that it is also available for the Websocket API offering. Unfortunately,
the set of metrics or metric names available in the HTTP API and
Websocket API offerings do not match up.

Hence, remove these metric names from Websocket APIs.

BREAKING CHANGE: The metricXXX methods are no longer available in the
IApi interface. The existing ones are moved into IHttpApi and new
ones will be added to IWebsocketApi.

  • apigatewayv2: The metricXXX methods are no longer available in
    the IStage interface. The existing ones are moved into IHttpStage
    and new ones will be added to the IWebsocketStage.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@nija-at nija-at requested a review from a team May 5, 2021 11:22
@nija-at nija-at self-assigned this May 5, 2021
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented May 5, 2021

@github-actions github-actions bot added the @aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 label May 5, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 5, 2021
…errors

In the HTTP API offering of API Gateway, the [metric names][1] for
client-side and server-side errors are '4xx' and '5xx'.

This was incorrectly configured as '4XXError' and '5XXError' which is
the [metric name in the REST API offering][2].

fixes #14503

In addition, a previous change elevated metrics defined in HTTP API such
that it is also available for the Websocket API offering. Unfortunately,
the set of metrics or metric names available in the [HTTP API][1] and
[Websocket API][3] offerings do not match up.

Hence, remove these metric names from Websocket APIs.

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-metrics.html
[2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html
[3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html

BREAKING CHANGES: The `metricXXX` methods are no longer available in the
`IApi` interface. The existing ones are moved into `IHttpApi` and new
ones will be added to `IWebsocketApi`.
* **apigatewayv2:** The `metricXXX` methods are no longer available in
the `IStage` interface. The existing ones are moved into `IHttpStage`
and new ones will be added to the `IWebsocketStage`.
@nija-at nija-at force-pushed the nija-at/apigwv2-metric-names branch from 2aed299 to 44b6562 Compare May 5, 2021 11:26
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 44b6562
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 551182e into master May 5, 2021
@mergify mergify bot deleted the nija-at/apigwv2-metric-names branch May 5, 2021 12:27
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented May 5, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

john-tipper pushed a commit to john-tipper/aws-cdk that referenced this pull request May 10, 2021
…errors (aws#14541)

In the HTTP API offering of API Gateway, the [metric names][1] for
client-side and server-side errors are '4xx' and '5xx'.

This was incorrectly configured as '4XXError' and '5XXError' which is
the [metric name in the REST API offering][2].

fixes aws#14503

In addition, a previous change elevated metrics defined in HTTP API such
that it is also available for the Websocket API offering. Unfortunately,
the set of metrics or metric names available in the [HTTP API][1] and
[Websocket API][3] offerings do not match up.

Hence, remove these metric names from Websocket APIs.

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-metrics.html
[2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html
[3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html

BREAKING CHANGE: The `metricXXX` methods are no longer available in the
`IApi` interface. The existing ones are moved into `IHttpApi` and new
ones will be added to `IWebsocketApi`.
* **apigatewayv2:** The `metricXXX` methods are no longer available in
the `IStage` interface. The existing ones are moved into `IHttpStage`
and new ones will be added to the `IWebsocketStage`.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
…errors (aws#14541)

In the HTTP API offering of API Gateway, the [metric names][1] for
client-side and server-side errors are '4xx' and '5xx'.

This was incorrectly configured as '4XXError' and '5XXError' which is
the [metric name in the REST API offering][2].

fixes aws#14503

In addition, a previous change elevated metrics defined in HTTP API such
that it is also available for the Websocket API offering. Unfortunately,
the set of metrics or metric names available in the [HTTP API][1] and
[Websocket API][3] offerings do not match up.

Hence, remove these metric names from Websocket APIs.

[1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-metrics.html
[2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html
[3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html

BREAKING CHANGE: The `metricXXX` methods are no longer available in the
`IApi` interface. The existing ones are moved into `IHttpApi` and new
ones will be added to `IWebsocketApi`.
* **apigatewayv2:** The `metricXXX` methods are no longer available in
the `IStage` interface. The existing ones are moved into `IHttpStage`
and new ones will be added to the `IWebsocketStage`.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@aws-cdk/aws-apigatewayv2 Related to Amazon API Gateway v2 contribution/core This is a PR that came from AWS.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(@aws-cdk/aws-apigatewayv2): Incorrect metric names for 4xx and 5xx

3 participants