[chore] Support connector in metrics.go.tmpl NewMetricsBuilder #12403

Dainerx · 2025-02-17T10:29:24Z

Description

I discovered this issue while trying to upgrade the opentelemetry collector from v0.111.0 to v0.119.0 that was released two weeks ago. To reproduce please take a look at the issue below.

Link to tracking issue

Fixes #12402

Testing

Run make generate on a processor or connector component

codecov · 2025-02-17T11:05:09Z

Codecov Report

Attention: Patch coverage is 90.62500% with 45 lines in your changes missing coverage. Please review.

Project coverage is 91.97%. Comparing base (0b6c04b) to head (c496a2f).

Files with missing lines	Patch %	Lines
...leconnector/internal/metadata/generated_metrics.go	91.83%	27 Missing and 2 partials ⚠️
...pleconnector/internal/metadata/generated_config.go	82.85%	8 Missing and 4 partials ⚠️
...econnector/internal/metadata/generated_resource.go	91.11%	4 Missing ⚠️

❌ Your patch check has failed because the patch coverage (90.62%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #12403      +/-   ##
==========================================
- Coverage   92.00%   91.97%   -0.03%     
==========================================
  Files         469      473       +4     
  Lines       25355    25835     +480     
==========================================
+ Hits        23327    23762     +435     
- Misses       1619     1658      +39     
- Partials      409      415       +6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bogdandrutu · 2025-02-17T16:40:35Z

@Dainerx what other component do you have that emits metrics?

Dainerx · 2025-02-17T16:45:47Z

@bogdandrutu in my use case, processors and connectors do emit metrics.

My main concern is the if statement surrounding only the function signature. Also, I expected adding a new class in the metadata schema.

bogdandrutu · 2025-02-17T17:34:12Z

My main concern is the if statement surrounding only the function signature. Also, I expected adding a new class in the metadata schema.

That should be fixed.

processors and connectors do emit metrics.

How come? I can see why connectors may do it, but how come the processors?

Dainerx · 2025-02-18T11:59:10Z

How come? I can see why connectors may do it, but how come the processors?

Processors can have mutate data capabilities, the metrics generation processor does generate metrics. Although, this is possible, I agree with you it's not a best practice to use a processor to generate metrics.

I am fine with only supporting connector scrapper, and receiver. We should also:

Add a sample connector to be used for testing purposes to check the output of mdatagen against it
Update the README file.

WDYT?

bogdandrutu · 2025-02-18T16:23:58Z

I am ok with this proposal.

bogdandrutu

I am not sure what changed, but this looks very strange that every line is updated.

cmd/mdatagen/README.md

cmd/mdatagen/internal/sampleconnector/metadata.yaml

cmd/mdatagen/internal/sampleconnector/factory.go

cmd/mdatagen/internal/sampleconnector/metadata.yaml

dmitryax · 2025-02-26T17:55:57Z

cmd/mdatagen/internal/sampleconnector/metadata.yaml

+    description: Attribute with a map value.
+    type: map
+
+metrics:


Why is this added to a connector? The metrics section is supposed to be set on scraping receivers only

Sorry, I missed the discussion above... Do you have a connector emitting metrics open sourced? It's not in contrib, right?

Sorry, I missed the discussion above... Do you have a connector emitting metrics open sourced? It's not in contrib, right?

Right

Dainerx · 2025-02-27T15:26:58Z

cmd/mdatagen/metadata-schema.yaml

@@ -13,15 +13,15 @@ generated_package_name: string
 # Required for components (Optional for subcomponents): A high-level view of the development status and use of this component
 status:
  # Required: The class of the component (For example receiver)
-  class: <receiver|processor|exporter|connector|extension|cmd|pkg|scraper|converter|provider>
+  class: <receiver|processor|exporter|connector|extension|scraper|cmd|pkg>


Revert changes here

linux-foundation-easycla · 2025-02-27T17:09:51Z

The committers listed above are authorized under a signed CLA.

✅ login: Dainerx / name: Oussama Ben Ghorbel (c496a2f)

bogdandrutu · 2025-02-28T18:09:45Z

cmd/mdatagen/internal/templates/metrics.go.tmpl

@@ -293,7 +290,7 @@ func (mb *MetricsBuilder) EmitForResource(options ...ResourceMetricsOption) {
 	rm.SetSchemaUrl(conventions.SchemaURL)
 	{{- end }}
 	ils := rm.ScopeMetrics().AppendEmpty()
-	ils.Scope().SetName(ScopeName)


Why whit change?

bogdandrutu · 2025-02-28T18:10:15Z

cmd/mdatagen/metadata-schema.yaml

@@ -13,7 +13,7 @@ generated_package_name: string
 # Required for components (Optional for subcomponents): A high-level view of the development status and use of this component
 status:
  # Required: The class of the component (For example receiver)
-  class: <receiver|processor|exporter|connector|extension|cmd|pkg|scraper|converter|provider>


Why this change?

No longer blocking this.

Dainerx requested review from dmitryax and a team as code owners February 17, 2025 10:29

github-actions bot added the cmd/mdatagen label Feb 17, 2025

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch from c7f4818 to bb83847 Compare February 17, 2025 10:35

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch from bb83847 to 4355c04 Compare February 17, 2025 16:22

Dainerx changed the title ~~[chore] Remove conditional statement on metrics.go.tmpl NewMetricsBuilder~~ [chore] Support connector in metrics.go.tmpl NewMetricsBuilder Feb 18, 2025

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch from 4355c04 to 9dded0f Compare February 18, 2025 12:28

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch 2 times, most recently from 0a0f205 to 7d5fcd2 Compare February 18, 2025 16:57

bogdandrutu previously requested changes Feb 18, 2025

View reviewed changes

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch 2 times, most recently from 31d7313 to 54a8c7c Compare February 20, 2025 12:14

sincejune reviewed Feb 22, 2025

View reviewed changes

cmd/mdatagen/README.md Outdated Show resolved Hide resolved

cmd/mdatagen/internal/sampleconnector/metadata.yaml Outdated Show resolved Hide resolved

sincejune reviewed Feb 22, 2025

View reviewed changes

cmd/mdatagen/internal/sampleconnector/factory.go Outdated Show resolved Hide resolved

sincejune reviewed Feb 22, 2025

View reviewed changes

cmd/mdatagen/internal/sampleconnector/metadata.yaml Outdated Show resolved Hide resolved

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch from d410125 to 4207422 Compare February 26, 2025 17:51

dmitryax reviewed Feb 26, 2025

View reviewed changes

Dainerx commented Feb 27, 2025

View reviewed changes

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch from 4207422 to 380f3b1 Compare February 27, 2025 17:09

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch 4 times, most recently from 26d7c6d to acdde27 Compare February 28, 2025 14:05

[chore] Support connector in metrics.go.tmpl NewMetricsBuilder

c496a2f

Dainerx force-pushed the fix/cmd/mdatada-gen-metrics branch from acdde27 to c496a2f Compare February 28, 2025 15:10

bogdandrutu reviewed Feb 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[chore] Support connector in metrics.go.tmpl NewMetricsBuilder #12403

[chore] Support connector in metrics.go.tmpl NewMetricsBuilder #12403

Dainerx commented Feb 17, 2025 •

edited

Loading

codecov bot commented Feb 17, 2025 •

edited

Loading

bogdandrutu commented Feb 17, 2025

Dainerx commented Feb 17, 2025

bogdandrutu commented Feb 17, 2025

Dainerx commented Feb 18, 2025 •

edited

Loading

bogdandrutu commented Feb 18, 2025

bogdandrutu left a comment

dmitryax Feb 26, 2025

dmitryax Feb 26, 2025 •

edited

Loading

Dainerx Feb 27, 2025

Dainerx Feb 27, 2025

linux-foundation-easycla bot commented Feb 27, 2025 •

edited

Loading

bogdandrutu Feb 28, 2025

bogdandrutu Feb 28, 2025

[chore] Support connector in metrics.go.tmpl NewMetricsBuilder #12403

Are you sure you want to change the base?

[chore] Support connector in metrics.go.tmpl NewMetricsBuilder #12403

Conversation

Dainerx commented Feb 17, 2025 • edited Loading

Description

Link to tracking issue

Testing

codecov bot commented Feb 17, 2025 • edited Loading

Codecov Report

bogdandrutu commented Feb 17, 2025

Dainerx commented Feb 17, 2025

bogdandrutu commented Feb 17, 2025

Dainerx commented Feb 18, 2025 • edited Loading

bogdandrutu commented Feb 18, 2025

bogdandrutu left a comment

Choose a reason for hiding this comment

dmitryax Feb 26, 2025

Choose a reason for hiding this comment

dmitryax Feb 26, 2025 • edited Loading

Choose a reason for hiding this comment

Dainerx Feb 27, 2025

Choose a reason for hiding this comment

Dainerx Feb 27, 2025

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Feb 27, 2025 • edited Loading

bogdandrutu Feb 28, 2025

Choose a reason for hiding this comment

bogdandrutu Feb 28, 2025

Choose a reason for hiding this comment

Dainerx commented Feb 17, 2025 •

edited

Loading

codecov bot commented Feb 17, 2025 •

edited

Loading

Dainerx commented Feb 18, 2025 •

edited

Loading

dmitryax Feb 26, 2025 •

edited

Loading

linux-foundation-easycla bot commented Feb 27, 2025 •

edited

Loading