Skip to content

Beats Developer Guide meta-issue #11102

Closed
@fearful-symmetry

Description

@fearful-symmetry

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?

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions