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] Add Kinesis Metrics datastream #3829

Merged
merged 5 commits into from
Jul 27, 2022

Conversation

legoguy1000
Copy link
Contributor

@legoguy1000 legoguy1000 commented Jul 25, 2022

What does this PR do?

Add AWS Kinesis Metrics Datastream

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

@legoguy1000 legoguy1000 requested a review from a team as a code owner July 25, 2022 16:43
@elasticmachine
Copy link

elasticmachine commented Jul 25, 2022

💚 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: 2022-07-27T19:19:34.523+0000

  • Duration: 34 min 25 sec

Test stats 🧪

Test Results
Failed 0
Passed 346
Skipped 0
Total 346

🤖 GitHub comments

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

  • /test : Re-trigger the build.

@kaiyan-sheng
Copy link
Contributor

/test

@kaiyan-sheng
Copy link
Contributor

@legoguy1000 Thank you for migrating this data stream!! One quick question: I think we have a dashboard for kinesis metrics in Metricbeat. Can we also move the dashboard over? Thank you!

@kaiyan-sheng kaiyan-sheng self-requested a review July 25, 2022 18:56
@kaiyan-sheng kaiyan-sheng added Integration:aws AWS Team:Cloud-Monitoring Label for the Cloud Monitoring team labels Jul 25, 2022
@elasticmachine
Copy link

elasticmachine commented Jul 25, 2022

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (11/11) 💚
Files 91.667% (11/12) 👎 -5.465
Classes 91.667% (11/12) 👎 -5.465
Methods 82.243% (176/214) 👎 -7.018
Lines 92.894% (2157/2322) 👍 2.299
Conditionals 100.0% (0/0) 💚

@legoguy1000 legoguy1000 requested a review from a team as a code owner July 25, 2022 23:36
@legoguy1000
Copy link
Contributor Author

@kaiyan-sheng I'll resolve the conflicts here when #3799 is merged.

@kaiyan-sheng
Copy link
Contributor

/test

Copy link
Contributor

@kaiyan-sheng kaiyan-sheng left a comment

Choose a reason for hiding this comment

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

I think the sample_event.json file needs to be updated. But I can help regenerate that in a separate PR.

@legoguy1000
Copy link
Contributor Author

legoguy1000 commented Jul 27, 2022 via email

@kaiyan-sheng kaiyan-sheng merged commit eb82fe9 into elastic:main Jul 27, 2022
Copy link
Contributor

@drewdaemon drewdaemon left a comment

Choose a reason for hiding this comment

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

I'm sorry that I wasn't able to review this sooner. Thank you for using Lens in your dashboard! A couple points about dashboard best practices:

  • "Library visualizations" (aka "by-reference" visualizations) should generally be avoided. These are added to the user's "Visualize library" in Kibana instead of being limited to just the dashboard. You can tell that a visualization is "by-reference" because a little file icon will show up at the top right of the panel. It's easy to change these to by-value by clicking the unlink button. This issue should be resolved this particular dashboard by Inline all aws dashboards #3688

Screen Shot 2022-07-28 at 12 11 32 PM

  • Dashboard-native controls should be used instead of the deprecated "input controls" visualization type. Here is the documentation for dashboard-native controls.

This is what the old stuff looks like:

Screen Shot 2022-07-28 at 12 21 23 PM

This is what the new stuff looks like:
Screen Shot 2022-07-28 at 12 26 31 PM

This information is all available in the best practices document.

@legoguy1000
Copy link
Contributor Author

legoguy1000 commented Jul 28, 2022 via email

@drewdaemon
Copy link
Contributor

drewdaemon commented Jul 28, 2022

@legoguy1000 I totally get it. It's what I would do, too. It's sort of like the power of defaults.

We're pushing best practices in integrations because our customers often follow exactly the same workflow of copy-modify-publish with the integration dashboards. It's leverage to get customers using the best possible tools.

@legoguy1000
Copy link
Contributor Author

legoguy1000 commented Jul 28, 2022 via email

@legoguy1000
Copy link
Contributor Author

legoguy1000 commented Oct 11, 2022 via email

@ruflin
Copy link
Contributor

ruflin commented Oct 11, 2022

@jsoriano See above conversation and also in #4064 around by value / by reference. It would be great if there is an automated way to make our community contributors aware of these things to make their life easier. I remember we had a discussion around potentially bringing this in as a CI check or similar but couldn't find it anymore.

@jsoriano
Copy link
Member

@jsoriano See above conversation and also in #4064 around by value / by reference. It would be great if there is an automated way to make our community contributors aware of these things to make their life easier. I remember we had a discussion around potentially bringing this in as a CI check or similar but couldn't find it anymore.

@ruflin a warning was added for this in elastic/package-spec#389. If warnings are not enough we may need to think in other strategies, or make this an error in CI.

@ruflin
Copy link
Contributor

ruflin commented Oct 13, 2022

@jsoriano To see this warning, someone needs to open the CI logs? @legoguy1000 Did you ever stumble over these?

@jsoriano The more intrusive way would be with a comment as part of the coverage report or one of the other automatic comments from CI.

@jsoriano
Copy link
Member

@jsoriano To see this warning, someone needs to open the CI logs? @legoguy1000 Did you ever stumble over these?

These warnings also appear when running elastic-package locally. This check was recently implemented, after this PR was merged, so I guess it didn't appear in this case.

@jsoriano The more intrusive way would be with a comment as part of the coverage report or one of the other automatic comments from CI.

Yeah, it'd be good if we had more easily consumable warnings, I have added a mention to this in elastic/package-spec#342.

@legoguy1000
Copy link
Contributor Author

@jsoriano To see this warning, someone needs to open the CI logs? @legoguy1000 Did you ever stumble over these?

@jsoriano The more intrusive way would be with a comment as part of the coverage report or one of the other automatic comments from CI.

You're talking about having visualizations embedded in the dashboards instead of separate files that are referenced? If so I can't remember that for this PR but I've definitely seen it lately and I'll be honest for the dashboards that I've copied from existing beats modules I haven't really done anything with them besides copy and update the fields.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Integration:aws AWS Team:Cloud-Monitoring Label for the Cloud Monitoring team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[AWS] migrate AWS Kinesis module from beats to integrations
6 participants