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

Beats Developer Guide meta-issue #11102

Closed
6 of 13 tasks
fearful-symmetry opened this issue Mar 5, 2019 · 1 comment
Closed
6 of 13 tasks

Beats Developer Guide meta-issue #11102

fearful-symmetry opened this issue Mar 5, 2019 · 1 comment

Comments

@fearful-symmetry
Copy link
Contributor

fearful-symmetry commented Mar 5, 2019

All of our overarching developer docs issues are kind of old (#4059 was a bit dated so we decided to close it) so @jsoriano And I decided to open a new meta-issue, as I in particular had some problems with the Beats developer guide before I got here.

Metricbeat specific:

  • A best practices document for metricsets, to standardize things like test layout, error handling, etc.
  • Data transformation for metricsets is mentioned in two places, here and here. The first page demonstrates a typical example of a data.go file, but data.go itself and usage of the standard eventMapping() function is explicitly called out in the second page. Maybe this should all be in one place?
  • We do mention testing for metricsets but we don't mention the standard TestData() and TestFetch() integration tests that most metricsets have. [metricbeat] Expand metricbeat dev guide for testing #12105
  • I've been here for a couple months and I'm still learning about new targets for make/mage. We should document all these somewhere?
@jlind23
Copy link
Collaborator

jlind23 commented Apr 1, 2022

Backlog grooming: Closing for now until further update

@jlind23 jlind23 closed this as completed Apr 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants