Skip to content

Add Instana Propagator: Instana Propagator Extension #1582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

HeenaBansal20
Copy link

@HeenaBansal20 HeenaBansal20 commented May 6, 2025

Which problem is this PR solving?
This PR adds a vendor specific propagator for the vendor specific trace correlation headers used by Instana.

Short description of the changes
Add Instana propagator plus unit tests.

@HeenaBansal20 HeenaBansal20 requested a review from a team as a code owner May 6, 2025 05:46
Copy link

welcome bot commented May 6, 2025

Thanks for opening your first pull request! If you haven't yet signed our Contributor License Agreement (CLA), then please do so that we can accept your contribution. A link should appear shortly in this PR if you have not already signed one.

Copy link

linux-foundation-easycla bot commented May 6, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@brettmc
Copy link
Collaborator

brettmc commented May 8, 2025

This looks like a good start - there are a few CI issues to fix (you can run all these checks locally, check out developer/contributing documentation)

@HeenaBansal20
Copy link
Author

HeenaBansal20 commented May 8, 2025

@brettmc , I have fixed the CI issues locally and hoping it will be fine in CI too, But I don't see CI checks gets triggered for the PR.
The deptrac reported the below violation on registry.php. However I do see that this is required and other propagators also uses to register their propagator class. I am not sure what needs to be done for this one.

Reason      Extension                                                                                            
----------- ----------------------------------------------------------------------------------------------------- 
 Violation   /src/Extension/Propagator/Instana/_register.php must not depend on OpenTelemetry\SDK\Registry (SDK)  
             /usr/src/myapp/src/Extension/Propagator/Instana/_register.php:7                                      
 Violation   /src/Extension/Propagator/Instana/_register.php must not depend on OpenTelemetry\SDK\Registry (SDK)  
             /usr/src/myapp/src/Extension/Propagator/Instana/_register.php:10                                     
----------- -----------------------------------------------------------------------------------------------------

Thanks

@HeenaBansal20 HeenaBansal20 marked this pull request as ready for review May 8, 2025 10:08
@HeenaBansal20 HeenaBansal20 marked this pull request as draft May 8, 2025 10:36
Copy link
Contributor

@Nevay Nevay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This propagator must not be maintained in this repository, see Propagators Distribution:

Additional Propagators implementing vendor-specific protocols such as AWS
X-Ray trace header protocol MUST NOT be maintained or distributed as part of
the Core OpenTelemetry repositories.

@HeenaBansal20
Copy link
Author

This propagator must not be maintained in this repository, see Propagators Distribution:

Additional Propagators implementing vendor-specific protocols such as AWS
X-Ray trace header protocol MUST NOT be maintained or distributed as part of
the Core OpenTelemetry repositories.

@Nevay , I understand that vendor-specific propagators are not maintained by the core opentelemetry-php maintainers. However, I noticed that the opentelemetry-js-contrib repository hosts an Instana propagator for Node.js, which inspired the idea to host the Instana propagator for PHP here as well.

That said, I’m happy to volunteer myself and my colleague as maintainers for this extension.

Since @brettmc expressed support for contributing the Instana propagator to this repository, I’ve gone ahead and submitted a PR.

Looking forward to your thoughts or suggestions.

@HeenaBansal20 HeenaBansal20 requested a review from Nevay May 8, 2025 21:22
@ChrisLightfootWild
Copy link
Contributor

This propagator must not be maintained in this repository, see Propagators Distribution:

Additional Propagators implementing vendor-specific protocols such as AWS
X-Ray trace header protocol MUST NOT be maintained or distributed as part of
the Core OpenTelemetry repositories.

@Nevay , I understand that vendor-specific propagators are not maintained by the core opentelemetry-php maintainers. However, I noticed that the opentelemetry-js-contrib repository hosts an Instana propagator for Node.js, which inspired the idea to host the Instana propagator for PHP here as well.

That said, I’m happy to volunteer myself and my colleague as maintainers for this extension.

Since @brettmc expressed support for contributing the Instana propagator to this repository, I’ve gone ahead and submitted a PR.

Looking forward to your thoughts or suggestions.

The referenced contrib repo is https://github.com/open-telemetry/opentelemetry-php-contrib.

This PR is currently against the PHP Core repo, https://github.com/open-telemetry/opentelemetry-php and should thus be ported to contrib.

@HeenaBansal20
Copy link
Author

This propagator must not be maintained in this repository, see Propagators Distribution:

Additional Propagators implementing vendor-specific protocols such as AWS
X-Ray trace header protocol MUST NOT be maintained or distributed as part of
the Core OpenTelemetry repositories.

@Nevay , I understand that vendor-specific propagators are not maintained by the core opentelemetry-php maintainers. However, I noticed that the opentelemetry-js-contrib repository hosts an Instana propagator for Node.js, which inspired the idea to host the Instana propagator for PHP here as well.
That said, I’m happy to volunteer myself and my colleague as maintainers for this extension.
Since @brettmc expressed support for contributing the Instana propagator to this repository, I’ve gone ahead and submitted a PR.
Looking forward to your thoughts or suggestions.

The referenced contrib repo is https://github.com/open-telemetry/opentelemetry-php-contrib.

This PR is currently against the PHP Core repo, https://github.com/open-telemetry/opentelemetry-php and should thus be ported to contrib.

Thanks @ChrisLightfootWild for suggestion. I agree this extension should be ported to opentelemetry-php-contrib. I'll move this PR there.
Thank you.

@HeenaBansal20
Copy link
Author

Opened the PR under opentelemetry-php-contrib repo and Hence closing this one.
open-telemetry/opentelemetry-php-contrib#365

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants