Fix WithSpanHandler: remove hardcode, add constants instead by mdomansky · Pull Request #1927 · open-telemetry/opentelemetry-php

mdomansky · 2026-03-25T14:37:12Z

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 · 2026-03-25T14:37:22Z

The committers listed above are authorized under a signed CLA.

✅ login: mdomansky / name: mdomansky (48ba75b, 4edbdf6, 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 · 2026-03-26T09:04:34Z

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 · 2026-03-26T09:44:43Z

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 · 2026-04-08T12:17:41Z

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

mx-psi · 2026-04-08T12:26:26Z

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 · 2026-04-09T13:04:20Z

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

Co-authored-by: Tobias Bachert <github.dev.k9ps1@mail.tobiasbachert.com>

ChrisLightfootWild · 2026-04-10T11:36:06Z

+            ->setAttribute('code.function.name', $class !== null ? $class . '::' . $function : $function)
+            ->setAttribute('code.file.path', $filename)
+            ->setAttribute('code.line.number', $lineno)
+            ->setAttribute('code.column.number', $lineno)


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

Thanks. Fixed.

codecov · 2026-04-22T12:27:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.97%. Comparing base (938c2bc) to head (48ba75b).
⚠️ Report is 68 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1927      +/-   ##
============================================
- Coverage     68.29%   67.97%   -0.33%     
- Complexity     3009     3084      +75     
============================================
  Files           449      459      +10     
  Lines          8798     9031     +233     
============================================
+ Hits           6009     6139     +130     
- Misses         2789     2892     +103

Flag	Coverage Δ
8.1	`?`
8.2	`?`
8.3	`?`
8.4	`?`
8.5	`?`
8.6	`67.97% <100.00%> (?)`

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	`80.64% <100.00%> (-9.68%)`	⬇️

... and 42 files with indirect coverage changes

Continue to review full report in Codecov by Harness.

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

🚀 New features to boost your workflow:

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

Nevay · 2026-04-22T19:40:40Z

-            ->setAttribute('code.namespace', $class)
-            ->setAttribute('code.filepath', $filename)
-            ->setAttribute('code.lineno', $lineno)
+            ->setAttribute('code.function.name', $class !== null ? $class . '::' . $function : $function)


Could unify this with the span $name logic above:

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

Updated to the ->setAttribute('code.function.name', $name) due to $name setting above correct way I believe.

We cannot use $name for code.function.name, it might be overridden via $span_args.

Using the snippet above:
$name -> span name provided to ->spanBuilder()
$functionName -> code.function.name attribute

brettmc · 2026-08-28T05:35:25Z

It looks like all reviewers are happy with this change, but we're blocked on zizmor results... I'll close and reopen this PR, which should re-run all actions.

brettmc · 2026-08-28T05:41:08Z

@mdomansky sorry this has been waiting so long. I've just kicked off the checks and they're failing, I think a rebase will probably fix it given the age of this PR.

Remove hardcode, add constants

aeb9734

mdomansky requested a review from a team as a code owner March 25, 2026 14:37

ChrisLightfootWild reviewed Mar 25, 2026

View reviewed changes

bobstrecansky added the blocked this issue is blocked by another issue. label Apr 8, 2026

ChrisLightfootWild mentioned this pull request Apr 8, 2026

[opensearch] Error emitting telemetry in PHP with otel-collector open-telemetry/opentelemetry-collector-contrib#47465

Open

update otel schema to 1.40 and update span attributes within the schema

4fea690

Nevay reviewed Apr 9, 2026

View reviewed changes

Comment thread src/API/Instrumentation/WithSpanHandler.php Outdated

Update src/API/Instrumentation/WithSpanHandler.php

7400f5f

Co-authored-by: Tobias Bachert <github.dev.k9ps1@mail.tobiasbachert.com>

ChrisLightfootWild reviewed Apr 10, 2026

View reviewed changes

update otel schema to 1.40 and update span attributes within the schema

9efbcfb

mdomansky requested review from ChrisLightfootWild and Nevay April 22, 2026 09:34

update tests

b665a5a

Nevay approved these changes Apr 22, 2026

View reviewed changes

update otel function name

4edbdf6

mdomansky requested a review from Nevay April 27, 2026 07:24

update otel function name

48ba75b

intuibase approved these changes Jul 15, 2026

View reviewed changes

brettmc closed this Aug 28, 2026

brettmc reopened this Aug 28, 2026

brettmc removed the blocked this issue is blocked by another issue. label Aug 28, 2026

Uh oh!

Conversation

mdomansky commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChrisLightfootWild left a comment

Choose a reason for hiding this comment

Uh oh!

mdomansky commented Mar 26, 2026

Uh oh!

ChrisLightfootWild commented Mar 26, 2026

Uh oh!

bobstrecansky commented Apr 8, 2026

Uh oh!

mx-psi commented Apr 8, 2026

Uh oh!

mdomansky commented Apr 9, 2026

Uh oh!

Uh oh!

ChrisLightfootWild Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

mdomansky Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Nevay Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

mdomansky Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

Nevay Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

mdomansky May 8, 2026

Choose a reason for hiding this comment

Uh oh!

brettmc commented Aug 28, 2026

Uh oh!

brettmc commented Aug 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mdomansky commented Mar 25, 2026 •

edited

Loading

linux-foundation-easycla Bot commented Mar 25, 2026 •

edited

Loading

codecov Bot commented Apr 22, 2026 •

edited

Loading