Skip to content

Latest commit

 

History

History

mdatagen

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
testdata
testdata
 
 
third_party/golint
third_party/golint
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
documentation.tmpl
documentation.tmpl
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
lint.go
lint.go
 
 
lint_test.go
lint_test.go
 
 
loader.go
loader.go
 
 
loader_test.go
loader_test.go
 
 
main.go
main.go
 
 
main_test.go
main_test.go
 
 
metric-metadata.yaml
metric-metadata.yaml
 
 
metricdata.go
metricdata.go
 
 
metricdata_test.go
metricdata_test.go
 
 
metrics.tmpl
metrics.tmpl
 
 
metrics_v2.tmpl
metrics_v2.tmpl
 
 

README.md

Metadata Generator

Receivers can contain a metadata.yaml file that documents the metrics that may be emitted by the receiver.

Current examples:

  • hostmetricsreceiver scrapers like the cpuscraper

See metric-metadata.yaml for file format documentation.

If adding a new receiver a codegen.go file should also be added to trigger the generation. See below for details.

Build

When go generate is run (it is run automatically in the make build targets) there are a few special build directives in codegen.go files:

make install-tools results in cmd/mdatagen being installed to GOBIN

/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/codegen.go runs mdatagen for the hostmetricsreceiver metadata.yaml which generates the /receiver/hostmetricsreceiver/internal/scraper/cpuscraper/internal/metadata package which has Go files containing metric and label metadata.