Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AWS] [API Gateway] Add metrics dashboard filters, control groups and clean up #7702

Conversation

lucian-ioan
Copy link
Contributor

@lucian-ioan lucian-ioan commented Sep 7, 2023

A new issue will be made to document exactly why these additional documents are being generated and if there's a dashboard level solution for filtering them properly.

What does this PR do?

  1. Adds filter based on aws.dimensions.Stage to ensure that only documents containing this dimension are considered while visualizing the data. This is necessary due to extra documents currently being present in the metrics:

image

The lucian-REST-PetStore API has 2 stages (dev, prod), each with 32 and 64 aws.apigateway.metrics.Count.sum respectively, representing the number of requests made to them.

However, another document is present in the metrics with the combined number of requests (96) which also has no aws.dimensions.Stage present.

  1. Adds control groups using aws.dimensions.ApiId (HTTP, WebSocket), aws.dimensions.ApiName (REST) and aws.dimensions.Stage (REST, HTTP and WebSocket), as well as AWS Region.

  2. Removes unused lens ([WebSocket] Latency) because the metric is only for HTTP/REST.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

CloudWatch:
CloudWatch

Dashboard after changes:
AFTER

@lucian-ioan lucian-ioan self-assigned this Sep 7, 2023
@lucian-ioan lucian-ioan marked this pull request as ready for review September 7, 2023 15:35
@lucian-ioan lucian-ioan requested review from a team as code owners September 7, 2023 15:35
@elasticmachine
Copy link

elasticmachine commented Sep 7, 2023

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-09-07T15:32:22.051+0000

  • Duration: 56 min 8 sec

Test stats 🧪

Test Results
Failed 0
Passed 208
Skipped 4
Total 212

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented Sep 7, 2023

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (17/17) 💚
Files 94.444% (17/18) 👎 -2.21
Classes 94.444% (17/18) 👎 -2.21
Methods 85.953% (257/299) 👎 -6.338
Lines 86.024% (7509/8729) 👎 -2.31
Conditionals 100.0% (0/0) 💚

@lucian-ioan lucian-ioan merged commit 6928a62 into elastic:main Sep 7, 2023
4 checks passed
@elasticmachine
Copy link

Package aws - 2.2.0 containing this change is available at https://epr.elastic.co/search?package=aws

@lucian-ioan lucian-ioan changed the title [AWS] [API Gateway] Add dashboard filters, control groups and clean up [AWS] [API Gateway] Add metrics dashboard filters, control groups and clean up Sep 8, 2023
@lucian-ioan lucian-ioan deleted the aws_apigateway_metrics_dashboard_enhancement branch February 6, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[AWS] [API Gateway] Add metrics dashboard filters, control groups and clean up
3 participants