open-telemetry/opentelemetry-php

[Symfony auto-instrumentation] Messenger instrumentation should use SpanKind::KIND_PRODUCER, SpanKind::KIND_CONSUMER

Closed

#1,314 opened on May 20, 2024

View on GitHubContributor guide
 (18 comments) (0 reactions) (2 assignees)PHP (224 forks)auto 404
buggood first issuehelp wanted

Repository metrics

Stars
 (894 stars)
PR merge metrics
 (Avg merge 5d 5h) (5 merged PRs in 30d)

Description

Steps to reproduce

Enable Symfony auto-instrumentation with default setup.

What is the expected behavior?

Spans when creating the message should be marked with SpanKind::KIND_PRODUCER.

Spans when handling the message should be marked with SpanKind::KIND_CONSUMER.

https://opentelemetry.io/docs/specs/semconv/messaging/messaging-spans/#span-kind

What is the actual behavior?

Everything is marked KIND_INTERNAL and it seems the consumer is currently not instrumented at all (I might be wrong here, please feel free to correct me).

Additionally, it seems to me the names of the spans are also not correct, as shown in the table in the spec linked above?

Contributor guide

Research direction
Examine the Symfony auto instrumentation Messenger middleware and adjust span kind to PRODUCER when sending messages and CONSUMER when handling messages, following the OpenTelemetry messaging semantics.
Tech stack
php
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50