Fix WithSpanHandler: remove hardcode, add constants instead

[mdomansky]

I have a list of containers:
1 - my php app
2 - otel-collector
3 - opensearch

While using #[WithSpan] attribute on methods on my php container, all span information is successfully sent to the otel-collector container, but while the last sends the info to the opensearch database I get an exception:

error internal/base_exporter.go:115 Exporting failed. Rejecting data. Try enabling sending_queue to survive temporary failures. {"resource": {"[service.instance.id](http://service.instance.id/)": "c614aac8-2cfa-48f9-b109-a246a99f80ad", "[service.name](http://service.name/)": "otelcol-contrib", "service.version": "0.145.0"}, "[otelcol.component.id](http://otelcol.component.id/)": "opensearch", "otelcol.component.kind": "exporter", "otelcol.signal": "traces", "error": "not retryable error: Permanent error: {\"type\":\"mapper_parsing_exception\",\"reason\":\"object mapping for [attributes.code.function] tried to parse field [code.function] as object, but found a concrete value\",\"caused_by\":{\"type\":\"\",\"reason\":\"\",\"caused_by\":null}}", "rejected_items": 7}

My env:

OTEL_ENABLED: 'true'
OTEL_TRACES_EXPORTER: 'otlp'

Having researched, I found that "wrong" attribute names are hardcoded, so I updated them with constants.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: mdomansky / name: mdomansky (4fea690, 9efbcfb, aeb9734, b665a5a)
• ✅ login: mdomansky / name: Mike Domansky (7400f5f)
• ✅ login: Nevay / name: Tobias Bachert (7400f5f)

[ChrisLightfootWild]

This is intentionally hardcoded to avoid the dependency on SemConv in the API package.

[mdomansky]

This is intentionally hardcoded to avoid the dependency on SemConv in the API package.

Why do I get the issue like code.function is wrong while code.function.name is correct?

[ChrisLightfootWild]

This is intentionally hardcoded to avoid the dependency on SemConv in the API package.

Why do I get the issue like code.function is wrong while code.function.name is correct?

I believe code.function is correct for the emitted version of telemetry, 1.25.0. See https://github.com/open-telemetry/semantic-conventions/blob/v1.25.0/model/general.yaml#L55-L65

Might be worth asking the otel collector devs on this one. The schema file links to open-telemetry/semantic-conventions#1624 from the 1.30.0 semantic conventions. It contains the following:

...trimmed
  1.30.0:
    all:
      changes:
...trimmed
        - rename_attributes:
            attribute_map:
              code.function: code.function.name
              code.filepath: code.file.path
              code.lineno: code.line.number
              code.column: code.column.number

My understanding is that we are emitting valid telemetry for the schema version we have declared, and that the collector should rename the attributes during ingestion.

[bobstrecansky]

@open-telemetry/collector-approvers, can you weigh in here?

[mx-psi]

The error on this PR's description seems specific to the opensearch exporter, feel free to file an issue on the opentelemetry-collector-contrib bug tracker and the code owners will take a look

[mdomansky]

Updated the schema version and updated span attribute names according to the scheme. Left hardcoded attribute names.

[ChrisLightfootWild]

This doesn't look right. I don't think we should use the line number as column number.

[mdomansky]

Thanks. Fixed.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.26%. Comparing base (938c2bc) to head (9efbcfb).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1927      +/-   ##
============================================
- Coverage     68.29%   67.26%   -1.04%     
- Complexity     3009     3022      +13     
============================================
  Files           449      450       +1     
  Lines          8798     9139     +341     
============================================
+ Hits           6009     6147     +138     
- Misses         2789     2992     +203     

Flag	Coverage Δ
8.1	?
8.2	?
8.3	?
8.4	?
8.5	67.26% <100.00%> (-0.13%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/API/Instrumentation/WithSpanHandler.php	90.00% <100.00%> (-0.33%)	⬇️

... and 218 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 938c2bc...9efbcfb. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Nevay]

Could unify this with the span $name logic above:

$functionName = $class !== null ? $class . '::' . $function : $function;
$name = $span_args['name'] ?? $functionName;