[connector/spanmetricsconnector] fix default metrics initialization

[LaserPhaser]

Description: Added an ability to remove default labels from metrics
Fixing [GH-16344]

Link to tracking Issue: [GH-16344]

Testing: Test added to the config_tests.go file

Documentation: Readme.md updated

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: LaserPhaser / name: Laser (22543ba)

[kovrus]

@LaserPhaser have you considered using the delete_key or keep_keys functions of the transform processor to achieve the same goal?

[LaserPhaser]

@LaserPhaser have you considered using the delete_key or keep_keys functions of the transform processor to achieve the same goal?

actually no,
but if it's preferred way I can do it.

[kovrus]

Let me know if it works for you.

[LaserPhaser]

Let me know if it works for you.
Updated.

[kovrus]

Sorry, I was not clear. What I meant is to use the transform processor component after the spanmetrics component in the collector pipeline. For example

...
 processors:
   transform:
     metric_statements:
       - context: datapoint
         statements:
            - delete_keys(attributes, ["span.kind", "status.code", ...])

 connectors:
   spanmetrics:

 service:
   pipelines:
     traces:
       receivers: [...]
       exporters: [spanmetrics]
     metrics:
       receivers: [spanmetrics]
       processors: [transform]
       exporters: [....]
       
 ...      

Then we do not have to add this functionality to the spanmetrics connector.

[rlex]

Also interested in this. I need only _calls part.

I managed to remove unneeded labels with transform keep_keys, but i can't seemingly remove duration metrics.

i tried

          connectors:
            spanmetrics:
              namespace: span.metrics
          processors:
            transform/spanmetrics_attributes_cleanup:
              metric_statements:
                - context: datapoint
                  statements:
                    - keep_keys(attributes, ["service.name", "status.code"])
            filter/spanmetrics_filterlist:
              metrics:
                exclude:
                  match_type: regexp
                  metric_names:
                    - span_metrics_duration_.*

Bit i still see all span_metrics_duration metrics arriving to my tsdb. Am i missing something?

[kovrus]

Also interested in this. I need only _calls part.

I managed to remove unneeded labels with transform keep_keys, but i can't seemingly remove duration metrics.

i tried

          connectors:
            spanmetrics:
              namespace: span.metrics
          processors:
            transform/spanmetrics_attributes_cleanup:
              metric_statements:
                - context: datapoint
                  statements:
                    - keep_keys(attributes, ["service.name", "status.code"])
            filter/spanmetrics_filterlist:
              metrics:
                exclude:
                  match_type: regexp
                  metric_names:
                    - span_metrics_duration_.*

Bit i still see all span_metrics_duration metrics arriving to my tsdb. Am i missing something?

In your case, spanmetrics duration will be generating the OTel span.metrics.duration metric. The name that you should be filtering is span.metrics.duration. It becomes span_metrics_duration_{count/sum/bucket} once exported with Prometheus exporters.

[LaserPhaser]

Let me know if it works for you.

works for me
thx

[rlex]

Also interested in this. I need only _calls part.
I managed to remove unneeded labels with transform keep_keys, but i can't seemingly remove duration metrics.
i tried

          connectors:
            spanmetrics:
              namespace: span.metrics
          processors:
            transform/spanmetrics_attributes_cleanup:
              metric_statements:
                - context: datapoint
                  statements:
                    - keep_keys(attributes, ["service.name", "status.code"])
            filter/spanmetrics_filterlist:
              metrics:
                exclude:
                  match_type: regexp
                  metric_names:
                    - span_metrics_duration_.*

Bit i still see all span_metrics_duration metrics arriving to my tsdb. Am i missing something?

In your case, spanmetrics duration will be generating the OTel span.metrics.duration metric. The name that you should be filtering is span.metrics.duration. It becomes span_metrics_duration_{count/sum/bucket} once exported with Prometheus exporters.

That worked, thanks! May i ask why dot-delimited format is needed? Because it's internal opentelemetry-collector metric and not produced by any external sources? span_metrics_duration hasn't worked for me for some reason.

[albertteoh]

dot-delimited format is needed?

@rlex, I think the motivation was to remain consistent with OTEL naming conventions.

The relevant discussion can be found here: #18199 (comment)

... and I think this is the reference to OTEL's naming convention: https://opentelemetry.io/docs/reference/specification/common/attribute-naming/.

[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.