[mdatagen] add CustomMetricName func

[codeboten]

This allows components to generate a consistent metric name. Doing this in mdatagen will allow us to remove the need to export methods in helpers, for example BuildCustomMetricName.

Eventually we might want to define the custom metrics for each component's internal telemetry via metadata.yaml, at which point we can remove this func. For now it allows us to clean up some more code.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 24 lines in your changes are missing coverage. Please review.

Project coverage is 90.28%. Comparing base (7abb962) to head (5d40865).
Report is 269 commits behind head on main.

Files	Patch %	Lines
cmd/mdatagen/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...ardconnector/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...ebugexporter/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...gingexporter/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...otlpexporter/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...httpexporter/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...astextension/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...terextension/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...gesextension/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
...tchprocessor/internal/metadata/generated_status.go	0.00%	2 Missing ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9455      +/-   ##
==========================================
- Coverage   90.40%   90.28%   -0.12%     
==========================================
  Files         344      344              
  Lines       18058    18082      +24     
==========================================
  Hits        16325    16325              
- Misses       1401     1425      +24     
  Partials      332      332              

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

[bogdandrutu]

I would maybe consider connector/forward as the meter name instead, since that would nicely group all the metrics.

[codeboten]

I would maybe consider connector/forward as the meter name instead, since that would nicely group all the metrics.

@bogdandrutu i think there's a few different ways we're currently customizing telemetry for internal components. In some cases, we're using a specific meter name:

https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/3952e23232bf6edd4f11d024c174d3aaf6b61a82/exporter/awss3exporter/internal/metadata/generated_status.go#L19

In others we're prefixing the component details in the name of the metric:

opentelemetry-collector/processor/processorhelper/obsreport.go

Line 36 in f5a7315

return componentPrefix + configType + obsmetrics.NameSep + metric

And in yet another case, we're adding specific component in a separate label:

opentelemetry-collector/exporter/exporterhelper/obsexporter.go

Line 64 in f5a7315

attribute.String(obsmetrics.ExporterKey, cfg.ExporterID.String()),

I think it makes sense to consolidate these into a consistent experience for component owners are well as end users, I would suggest using issue #9315 to decide on the right path to move forward. This PR allows us to hide the details of getting a custom metric name behind a generated method internal to components rather than an exposed API in the processor helper. WDYT?

[bogdandrutu]

In others we're prefixing the component details in the name of the metric:

We are doing that for legacy reasons, opencensus did not have a namespace/scope.

And in yet another case, we're adding specific component in a separate label:

I find no problem with this, since we record this from "exporterhelper" it is a fine way of doing it. We could have created different scopes per initialization or using one scope and put that as attribute. If you ask me what I would prefer is to put that in the scope, but again when that was created we had opencensus without namespace/scope so this was not an option.

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 14 days.

[github-actions]

Closed as inactive. Feel free to reopen if this PR is still being worked on.