Skip to content

[AWS API Gateway] Dashboard for metrics datastream#6476

Merged
lucian-ioan merged 6 commits intoelastic:mainfrom
lucian-ioan:add_aws-apigateway_dashboard
Jun 19, 2023
Merged

[AWS API Gateway] Dashboard for metrics datastream#6476
lucian-ioan merged 6 commits intoelastic:mainfrom
lucian-ioan:add_aws-apigateway_dashboard

Conversation

@lucian-ioan
Copy link
Contributor

@lucian-ioan lucian-ioan commented Jun 5, 2023 •
edited
Loading

What does this PR do?

Adds a dashboard for API Gateway metrics data stream. WIP.

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

aws_apigateway_metrics_dashboard

@lucian-ioan lucian-ioan self-assigned this Jun 5, 2023
@lucian-ioan lucian-ioan mentioned this pull request Jun 6, 2023
Closed
8 tasks
@lucian-ioan lucian-ioan marked this pull request as ready for review June 18, 2023 15:35
@lucian-ioan lucian-ioan requested review from a team as code owners June 18, 2023 15:35
@elasticmachine
Copy link

elasticmachine commented Jun 18, 2023 •
edited
Loading

💚 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-06-19T13:14:55.358+0000

  • Duration: 56 min 13 sec

Test stats 🧪

Test Results
Failed 0
Passed 193
Skipped 4
Total 197

🤖 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 Jun 18, 2023 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (15/15) 💚
Files 93.75% (15/16) 👎 -3.36
Classes 93.75% (15/16) 👎 -3.36
Methods 85.714% (240/280) 👎 -6.5
Lines 85.925% (7387/8597) 👎 -6.335
Conditionals 100.0% (0/0) 💚

@elasticmachine
Copy link

elasticmachine commented Jun 19, 2023

💚 Build Succeeded

History

cc @zmoog @lucian-ioan

zmoog
zmoog reviewed Jun 19, 2023
View reviewed changes
Copy link
Contributor

@zmoog zmoog left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The data types on the dashboard look good: request count, bytes, latency, 4xx, and 5xx errors.

I have a few general questions:

  • Labels: should we add a space between the words? For example, "IntegrationErrors" vs. "Integration Error".
  • Unit of measure: some visualization may benefit from adding a UOM, like the "ms" on latency values.
  • Field name differences: I know that different API Gateway types use distinct field names (4xx vs. 4XXError), but should we make this visible or use the same name on the dashboard for consistency since the semantics is the same?
  • The dashboard is very tall: should we consider splitting somehow?

I am looking forward to hearing from Drew o other Kibana Visualization team members!

@stratoula
Copy link

stratoula commented Jun 19, 2023

@zmoog thanx a lot. I agree that the dashboard looks good and also on:

  • labels, yes let's add some space between the words. Panel title has space in general so we can safely do it and will be more readable
  • Units, absolutely yes, it helps a lot for readability

Field name differences: I know that different API Gateway types use distinct field names (4xx vs. 4XXError), but should we make this visible or use the same name on the dashboard for consistency since the semantics is the same?

I agree, let's use the same name on dashboard for consistency

Now about the height, in general we encourage small dashboards. I don't know if it makes sense to make 2 or 3 dashboards semantically but if yes I agree. Otherwise we could possibly have more panels per row.

@lucian-ioan
Copy link
Contributor Author

lucian-ioan commented Jun 19, 2023 •
edited
Loading

@zmoog @stratoula This is how the updated dashboard looks:

screencapture-localhost-5601-app-dashboards-2023-06-19-15_11_27

For now I would just bundle all API types in a single dashboard since they all use API Gateway.
Suggestions are welcome as this is the first dashboard ever for me 😁

WDYT?

stratoula
stratoula approved these changes Jun 19, 2023
View reviewed changes
Copy link

@stratoula stratoula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM! We can def improve in the future and split in more dashboards but I think is fine for now!

zmoog
zmoog approved these changes Jun 19, 2023
View reviewed changes
Copy link
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as 1.0 🚢

@lucian-ioan
Copy link
Contributor Author

lucian-ioan commented Jun 19, 2023

/test

@lucian-ioan lucian-ioan merged commit da82847 into elastic:main Jun 19, 2023
@elasticmachine
Copy link

elasticmachine commented Jun 19, 2023

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

@lucian-ioan lucian-ioan linked an issue Jul 24, 2023 that may be closed by this pull request
AWS API Gateway Integration #6058
Closed
8 tasks
@lucian-ioan lucian-ioan deleted the add_aws-apigateway_dashboard branch February 6, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zmoog zmoog zmoog approved these changes

@stratoula stratoula stratoula approved these changes

Assignees

@lucian-ioan lucian-ioan

Labels

Integration:aws AWS

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[AWS API Gateway] Dashboard for metrics datastream AWS API Gateway Integration

5 participants

@lucian-ioan @elasticmachine @stratoula @zmoog @andrewkroh