[chore] migrate metrics to mdatagen (#33514)

Added metadata.yaml file to allow for generation of internal metrics.
Note the stability section of that file are not used anywhere, but
mdatagen requires it.

---------

Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -143,6 +143,7 @@ body:
       - pkg/resourcetotelemetry
       - pkg/sampling
       - pkg/stanza
+      - pkg/stanza/fileconsumer
       - pkg/translator/azure
       - pkg/translator/jaeger
       - pkg/translator/loki

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -137,6 +137,7 @@ body:
       - pkg/resourcetotelemetry
       - pkg/sampling
       - pkg/stanza
+      - pkg/stanza/fileconsumer
       - pkg/translator/azure
       - pkg/translator/jaeger
       - pkg/translator/loki

.github/ISSUE_TEMPLATE/other.yaml

@@ -137,6 +137,7 @@ body:
       - pkg/resourcetotelemetry
       - pkg/sampling
       - pkg/stanza
+      - pkg/stanza/fileconsumer
       - pkg/translator/azure
       - pkg/translator/jaeger
       - pkg/translator/loki

.github/ISSUE_TEMPLATE/unmaintained.yaml

@@ -142,6 +142,7 @@ body:
       - pkg/resourcetotelemetry
       - pkg/sampling
       - pkg/stanza
+      - pkg/stanza/fileconsumer
       - pkg/translator/azure
       - pkg/translator/jaeger
       - pkg/translator/loki

pkg/stanza/fileconsumer/config.go

@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+//go:generate mdatagen metadata.yaml
+
 package fileconsumer // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer"
 
 import (
@@ -12,7 +14,6 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/featuregate"
-	"go.opentelemetry.io/otel/metric"
 	"go.uber.org/zap"
 	"golang.org/x/text/encoding"
 
@@ -21,6 +22,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/emit"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/fingerprint"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/header"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/metadata"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/reader"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/scanner"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/tracker"
@@ -35,8 +37,6 @@ const (
 	defaultMaxConcurrentFiles = 1024
 	defaultEncoding           = "utf-8"
 	defaultPollInterval       = 200 * time.Millisecond
-	openFilesMetric           = "fileconsumer/open_files"
-	readingFilesMetric        = "fileconsumer/reading_files"
 )
 
 var allowFileDeletion = featuregate.GlobalRegistry().MustRegister(
@@ -179,34 +179,19 @@ func (c Config) Build(set component.TelemetrySettings, emit emit.Callback, opts
 		t = tracker.NewFileTracker(set, c.MaxConcurrentFiles/2)
 	}
 
-	meter := set.MeterProvider.Meter("otelcol/fileconsumer")
-
-	openFiles, err := meter.Int64UpDownCounter(
-		openFilesMetric,
-		metric.WithDescription("Number of open files"),
-		metric.WithUnit("1"),
-	)
-	if err != nil {
-		return nil, err
-	}
-	readingFiles, err := meter.Int64UpDownCounter(
-		readingFilesMetric,
-		metric.WithDescription("Number of open files that are being read"),
-		metric.WithUnit("1"),
-	)
+	telemetryBuilder, err := metadata.NewTelemetryBuilder(set)
 	if err != nil {
 		return nil, err
 	}
 	return &Manager{
-		set:           set,
-		readerFactory: readerFactory,
-		fileMatcher:   fileMatcher,
-		pollInterval:  c.PollInterval,
-		maxBatchFiles: c.MaxConcurrentFiles / 2,
-		maxBatches:    c.MaxBatches,
-		tracker:       t,
-		openFiles:     openFiles,
-		readingFiles:  readingFiles,
+		set:              set,
+		readerFactory:    readerFactory,
+		fileMatcher:      fileMatcher,
+		pollInterval:     c.PollInterval,
+		maxBatchFiles:    c.MaxConcurrentFiles / 2,
+		maxBatches:       c.MaxBatches,
+		tracker:          t,
+		telemetryBuilder: telemetryBuilder,
 	}, nil
 }
 

pkg/stanza/fileconsumer/documentation.md

@@ -0,0 +1,23 @@
+[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
+
+# fileconsumer
+
+## Internal Telemetry
+
+The following telemetry is emitted by this component.
+
+### fileconsumer_open_files
+
+Number of open files
+
+| Unit | Metric Type | Value Type | Monotonic |
+| ---- | ----------- | ---------- | --------- |
+| 1 | Sum | Int | false |
+
+### fileconsumer_reading_files
+
+Number of open files that are being read
+
+| Unit | Metric Type | Value Type | Monotonic |
+| ---- | ----------- | ---------- | --------- |
+| 1 | Sum | Int | false |

pkg/stanza/fileconsumer/file.go

@@ -11,11 +11,11 @@ import (
 	"time"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/otel/metric"
 	"go.uber.org/zap"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/checkpoint"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/fingerprint"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/metadata"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/reader"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/internal/tracker"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/fileconsumer/matcher"
@@ -36,8 +36,7 @@ type Manager struct {
 	maxBatches    int
 	maxBatchFiles int
 
-	openFiles    metric.Int64UpDownCounter
-	readingFiles metric.Int64UpDownCounter
+	telemetryBuilder *metadata.TelemetryBuilder
 }
 
 func (m *Manager) Start(persister operator.Persister) error {
@@ -74,7 +73,7 @@ func (m *Manager) Stop() error {
 		m.cancel = nil
 	}
 	m.wg.Wait()
-	m.openFiles.Add(context.TODO(), int64(0-m.tracker.ClosePreviousFiles()))
+	m.telemetryBuilder.FileconsumerOpenFiles.Add(context.TODO(), int64(0-m.tracker.ClosePreviousFiles()))
 	if m.persister != nil {
 		if err := checkpoint.Save(context.Background(), m.persister, m.tracker.GetMetadata()); err != nil {
 			m.set.Logger.Error("save offsets", zap.Error(err))
@@ -157,14 +156,14 @@ func (m *Manager) consume(ctx context.Context, paths []string) {
 		wg.Add(1)
 		go func(r *reader.Reader) {
 			defer wg.Done()
-			m.readingFiles.Add(ctx, 1)
+			m.telemetryBuilder.FileconsumerReadingFiles.Add(ctx, 1)
 			r.ReadToEnd(ctx)
-			m.readingFiles.Add(ctx, -1)
+			m.telemetryBuilder.FileconsumerReadingFiles.Add(ctx, -1)
 		}(r)
 	}
 	wg.Wait()
 
-	m.openFiles.Add(ctx, int64(0-m.tracker.EndConsume()))
+	m.telemetryBuilder.FileconsumerOpenFiles.Add(ctx, int64(0-m.tracker.EndConsume()))
 }
 
 func (m *Manager) makeFingerprint(path string) (*fingerprint.Fingerprint, *os.File) {
@@ -249,7 +248,7 @@ func (m *Manager) newReader(ctx context.Context, file *os.File, fp *fingerprint.
 		if err != nil {
 			return nil, err
 		}
-		m.openFiles.Add(ctx, 1)
+		m.telemetryBuilder.FileconsumerOpenFiles.Add(ctx, 1)
 		return r, nil
 	}
 
@@ -259,6 +258,6 @@ func (m *Manager) newReader(ctx context.Context, file *os.File, fp *fingerprint.
 	if err != nil {
 		return nil, err
 	}
-	m.openFiles.Add(ctx, 1)
+	m.telemetryBuilder.FileconsumerOpenFiles.Add(ctx, 1)
 	return r, nil
 }

pkg/stanza/fileconsumer/file_other.go

@@ -57,9 +57,9 @@ OUTER:
 		m.set.Logger.Debug("Reading lost file", zap.String("path", lostReader.GetFileName()))
 		go func(r *reader.Reader) {
 			defer lostWG.Done()
-			m.readingFiles.Add(ctx, 1)
+			m.telemetryBuilder.FileconsumerReadingFiles.Add(ctx, 1)
 			r.ReadToEnd(ctx)
-			m.readingFiles.Add(ctx, -1)
+			m.telemetryBuilder.FileconsumerReadingFiles.Add(ctx, -1)
 		}(lostReader)
 	}
 	lostWG.Wait()