[chore][mdatagen] Use MustNewType for metadata.Type (open-telemetry#3…

…1038)

**Description:** 

Follow up to open-telemetry/opentelemetry-collector/pull/9414, adds the
same changes in `mdatagen` regarding validation of `component.Type`s.

On this PR the validation logic and templating is a bit more complex
because of subcomponents. I will add these changes back on core once
this PR is merged.

**Link to tracking Issue:**
open-telemetry/opentelemetry-collector/issues/9208

cmd/mdatagen/main_test.go

@@ -328,8 +328,11 @@ import (
  "go.opentelemetry.io/otel/trace"
 )
 
+var (
+ Type = component.MustNewType("foo")
+)
+
 const (
- Type = "foo"
  MetricsStability = component.StabilityLevelBeta
 )
 
@@ -362,8 +365,11 @@ import (
  "go.opentelemetry.io/otel/trace"
 )
 
+var (
+ Type = component.MustNewType("foo")
+)
+
 const (
- Type = "foo"
  MetricsStability = component.StabilityLevelAlpha
 )
 

cmd/mdatagen/templates/status.go.tmpl

@@ -8,8 +8,13 @@ import (
  "go.opentelemetry.io/otel/trace"
 )
 
+{{ if eq .Parent "" }}
+var (
+ Type = component.MustNewType("{{ .Type }}")
+)
+{{- end }}
+
 const (
- Type = "{{ .Type }}"
  {{- range $stability, $signals := .Status.Stability }}
  {{- range $signal := $signals }}
  {{ toCamelCase $signal }}Stability = component.StabilityLevel{{ casesTitle $stability }}
@@ -23,4 +28,4 @@ func Meter(settings component.TelemetrySettings) metric.Meter {
 
 func Tracer(settings component.TelemetrySettings) trace.Tracer {
  return settings.TracerProvider.Tracer("{{ .ScopeName }}")
-}
+}

cmd/mdatagen/validate.go

@@ -6,6 +6,7 @@ package main
 import (
  "errors"
  "fmt"
+ "regexp"
 
  "go.opentelemetry.io/collector/pdata/pcommon"
  "go.uber.org/multierr"
@@ -28,10 +29,26 @@ func (md *metadata) Validate() error {
  return errs
 }
 
+// typeRegexp is used to validate the type of a component.
+// A type must start with an ASCII alphabetic character and
+// can only contain ASCII alphanumeric characters and '_'.
+// We allow '/' for subcomponents.
+// This must be kept in sync with the regex in component/config.go.
+var typeRegexp = regexp.MustCompile(`^[a-zA-Z][0-9a-zA-Z_]*$`)
+
 func (md *metadata) validateType() error {
  if md.Type == "" {
  return errors.New("missing type")
  }
+
+ if md.Parent != "" {
+ // subcomponents are allowed to have a '/' in their type.
+ return nil
+ }
+
+ if !typeRegexp.MatchString(md.Type) {
+ return fmt.Errorf("invalid character(s) in type %q", md.Type)
+ }
  return nil
 }
 

connector/servicegraphconnector/connector.go

@@ -84,7 +84,7 @@ type serviceGraphConnector struct {
 }
 
 func customMetricName(name string) string {
- return "connector/" + metadata.Type + "/" + name
+ return "connector/" + metadata.Type.String() + "/" + name
 }
 
 func newConnector(set component.TelemetrySettings, config component.Config) *serviceGraphConnector {

exporter/awscloudwatchlogsexporter/exporter.go

@@ -61,7 +61,7 @@ func newCwLogsPusher(expConfig *Config, params exp.CreateSettings) (*cwlExporter
  }
 
  // create CWLogs client with aws session config
- svcStructuredLog := cwlogs.NewClient(params.Logger, awsConfig, params.BuildInfo, expConfig.LogGroupName, expConfig.LogRetention, expConfig.Tags, session, metadata.Type)
+ svcStructuredLog := cwlogs.NewClient(params.Logger, awsConfig, params.BuildInfo, expConfig.LogGroupName, expConfig.LogRetention, expConfig.Tags, session, metadata.Type.String())
  collectorIdentifier, err := uuid.NewRandom()
 
  if err != nil {

exporter/awsemfexporter/emf_exporter.go

@@ -56,7 +56,7 @@ func newEmfExporter(config *Config, set exporter.CreateSettings) (*emfExporter,
  }
 
  // create CWLogs client with aws session config
- svcStructuredLog := cwlogs.NewClient(set.Logger, awsConfig, set.BuildInfo, config.LogGroupName, config.LogRetention, config.Tags, session, metadata.Type)
+ svcStructuredLog := cwlogs.NewClient(set.Logger, awsConfig, set.BuildInfo, config.LogGroupName, config.LogRetention, config.Tags, session, metadata.Type.String())
  collectorIdentifier, err := uuid.NewRandom()
 
  if err != nil {