open-telemetry/opentelemetry-php

service.version being set by Composer

Open

#1,320 opened on Jun 5, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)PHP (224 forks)auto 404
bite sizedbughelp wanted

Repository metrics

Stars
 (894 stars)
PR merge metrics
 (Avg merge 7d 3h) (15 merged PRs in 30d)

Description

@julianocosta89 opened a slack thread to discuss seeing the service.version resource attribute set, even though it was not being set by default.

After getting more clarity in the #otel-community-demo channel, @puckpuck mentioned the following:

I did some sleuthing. This is set in the Composer detector here: https://github.com/open-telemetry/opentelemetry-php/blob/main/src/SDK/Resource/Detectors/Composer.php#L23-L26
Within Composer if you don't have a version set you will get the Default version which matches what we see in the otel-demo https://github.com/composer/composer/blob/main/src/Composer/Package/RootPackage.php#L22
I wonder if we should be using the version from Composer if it is set to the Default (unset)?


We should probably determine how we want to handle this service.version in the future. Other SIGs do not set this by default, so perhaps maybe we shouldn't have composer set this value if possible.

Contributor guide

Research direction
Investigate how other OpenTelemetry SDKs handle the default service.version, and decide whether to skip setting it when Composer's version is the default. Also review the Composer detector code to see if we can avoid setting the version unless explicitly provided.
Tech stack
php
Domain
observabilitybackend
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
PHPComposer
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70