move selfdescribe in monitorcodegen, last place it's used (#5498)

signalfx · Oct 11, 2024 · b63ac24 · b63ac24
1 parent b08cdcb
commit b63ac24
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 27 deletions.
diff --git a/internal/signalfx-agent/cmd/monitorcodegen/main.go b/internal/signalfx-agent/cmd/monitorcodegen/main.go
@@ -14,16 +14,14 @@ import (
 	"unicode"
 
 	log "github.com/sirupsen/logrus"
-
-	"github.com/signalfx/signalfx-agent/pkg/selfdescribe"
 )
 
 const (
 	genMetadata               = "genmetadata.go"
 	generatedMetadataTemplate = "genmetadata.tmpl"
 )
 
-func buildOutputPath(pkg *selfdescribe.PackageMetadata) string {
+func buildOutputPath(pkg *packageMetadata) string {
 	outputDir := pkg.PackagePath
 	outputPackage := strings.TrimSpace(pkg.PackageDir)
 	if outputPackage != "" {
@@ -71,7 +69,7 @@ func generate(templateFile string) error {
 		return fmt.Errorf("parsing template %s failed: %s", generatedMetadataTemplate, err)
 	}
 
-	pkgs, err := selfdescribe.CollectMetadata("pkg/monitors")
+	pkgs, err := collectMetadata("pkg/monitors")
 
 	if err != nil {
 		return err
@@ -81,7 +79,7 @@ func generate(templateFile string) error {
 		pkg := &pkgs[i]
 		writer := &bytes.Buffer{}
 		groupMetricsMap := map[string][]string{}
-		metrics := map[string]selfdescribe.MetricMetadata{}
+		metrics := map[string]metricMetadata{}
 
 		for _, mon := range pkg.Monitors {
 			for metric, metricInfo := range mon.Metrics {

diff --git a/...gnalfx-agent/pkg/selfdescribe/metadata.go → ...alfx-agent/cmd/monitorcodegen/metadata.go b/...gnalfx-agent/pkg/selfdescribe/metadata.go → ...alfx-agent/cmd/monitorcodegen/metadata.go
@@ -1,4 +1,4 @@
-package selfdescribe
+package main
 
 import (
 	"fmt"
@@ -10,62 +10,62 @@ import (
 
 const monitorMetadataFile = "metadata.yaml"
 
-// MetricMetadata contains a metric's metadata.
-type MetricMetadata struct {
+// metricMetadata contains a metric's metadata.
+type metricMetadata struct {
 	Alias       string  `json:"alias,omitempty"`
 	Type        string  `json:"type"`
 	Description string  `json:"description"`
 	Group       *string `json:"group"`
 	Default     bool    `json:"default" default:"false"`
 }
 
-// PropMetadata contains a property's metadata.
-type PropMetadata struct {
+// propMetadata contains a property's metadata.
+type propMetadata struct {
 	Dimension   string `json:"dimension"`
 	Description string `json:"description"`
 }
 
-// GroupMetadata contains a group's metadata.
-type GroupMetadata struct {
+// groupMetadata contains a group's metadata.
+type groupMetadata struct {
 	Description string   `json:"description"`
 	Metrics     []string `json:"metrics"`
 }
 
-// MonitorMetadata contains a monitor's metadata.
-type MonitorMetadata struct {
+// monitorMetadata contains a monitor's metadata.
+type monitorMetadata struct {
 	MonitorType  string                    `json:"monitorType" yaml:"monitorType"`
 	SendAll      bool                      `json:"sendAll" yaml:"sendAll"`
 	SendUnknown  bool                      `json:"sendUnknown" yaml:"sendUnknown"`
 	NoneIncluded bool                      `json:"noneIncluded" yaml:"noneIncluded"`
-	Dimensions   map[string]DimMetadata    `json:"dimensions"`
+	Dimensions   map[string]dimMetadata    `json:"dimensions"`
 	Doc          string                    `json:"doc"`
-	Groups       map[string]*GroupMetadata `json:"groups"`
-	Metrics      map[string]MetricMetadata `json:"metrics"`
-	Properties   map[string]PropMetadata   `json:"properties"`
+	Groups       map[string]*groupMetadata `json:"groups"`
+	Metrics      map[string]metricMetadata `json:"metrics"`
+	Properties   map[string]propMetadata   `json:"properties"`
 }
 
-// PackageMetadata describes a package directory that may have one or more monitors.
-type PackageMetadata struct {
+// packageMetadata describes a package directory that may have one or more monitors.
+type packageMetadata struct {
 	// Common is a section to allow multiple monitors to place shared data.
 	Common map[string]interface{}
 	// PackageDir is the directory to output the generated code if not the same directory as the metadata.yaml.
 	PackageDir string `json:"packageDir" yaml:"packageDir"`
-	Monitors   []MonitorMetadata
+	Monitors   []monitorMetadata
 	// Name of the package in go. If not set defaults to the directory name.
 	GoPackage *string `json:"goPackage" yaml:"goPackage"`
 	// Filesystem path to the package directory.
 	PackagePath string `json:"-" yaml:"-"`
 	Path        string `json:"-" yaml:"-"`
 }
 
-// DimMetadata contains a dimension's metadata.
-type DimMetadata struct {
+// dimMetadata contains a dimension's metadata.
+type dimMetadata struct {
 	Description string `json:"description"`
 }
 
-// CollectMetadata loads metadata for all monitors located in root as well as any subdirectories.
-func CollectMetadata(root string) ([]PackageMetadata, error) {
-	var packages []PackageMetadata
+// collectMetadata loads metadata for all monitors located in root as well as any subdirectories.
+func collectMetadata(root string) ([]packageMetadata, error) {
+	var packages []packageMetadata
 
 	if err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
@@ -76,7 +76,7 @@ func CollectMetadata(root string) ([]PackageMetadata, error) {
 			return nil
 		}
 
-		var pkg PackageMetadata
+		var pkg packageMetadata
 
 		if bytes, err := os.ReadFile(path); err != nil {
 			return fmt.Errorf("unable to read metadata file %s: %w", path, err)