Adds opentracing compatibility. #7

jcchavezs · 2018-02-16T13:32:57Z

This PR adds compatibility with OpenTracing.

vlad-mh

Couple of nitpicks. Overall structure is GTM

vlad-mh · 2018-02-21T10:46:34Z

src/DDTrace/Span.php

-        $this->tracer = $tracer;
-        $this->name = (string) $name;
-        $this->service = $service;
+        $this->context = $context;


To my understanding, since this constructor is part of the publicly exposed API, we have no guarantee $context is not null, and we're not checking in the following function when using it?

The context can't be null as the typehint forces it to be SpanContext.

ah cool then 👍

vlad-mh · 2018-02-21T10:48:21Z

src/DDTrace/Span.php

+        foreach ($tags as $key => $value) {
+            if ($key !== (string) $key) {
+                throw new InvalidArgumentException(
+                    sprintf('First argument expected to be string, got %s', gettype($key))


I think we can re-word this exception to better reflect the function's new signature.

Sure, I am not a native so do you have any advice on how the reword would be better?

uhm, something like Invalid key type in given span tags. Expected string, got %s

Totally. The message I wrote is silly.

vlad-mh · 2018-02-21T12:49:01Z

src/DDTrace/Tracer.php

+                    $traceToBeSent = null;
+                    break;
+                }
+                $tracesToBeSent[] = $span;


I think it was supposed to be $traceToBeSent instead of $tracesToBeSent? We might want to rename one of the 2 vars to avoid confusion.

Totally. Nice catch!

kevinlebrun

LGTM.

The only thing that could bite you is the use of SPL exceptions. I do think you should scope those exceptions. It's totally fine to forward OpenTracing exceptions though.

Which versions of PHP are supported by the client?

kevinlebrun · 2018-02-21T16:45:55Z

src/DDTrace/Span.php

-     * @var string
-     */
-    private $spanId;
-
    /**
     * Name is the name of the operation being measured. Some examples


A detail but Name should be updated to operationName.

kevinlebrun · 2018-02-21T16:46:40Z

src/DDTrace/Span.php

        $service,
        $resource,
-        $traceId,
-        $spanId,
-        $parentId = null,
        $start = null


$startTime is more consistent with privates and $finishTime.

kevinlebrun · 2018-02-21T16:47:30Z

src/DDTrace/Span.php

-                sprintf('First argument expected to be string, got %s', gettype($key))
-            );
+        foreach ($tags as $key => $value) {
+            if ($key !== (string) $key) {


is_string is a little be more readable but... detail.

I know but this way is more performant and observability should have the least overhead possible.

kevinlebrun · 2018-02-21T16:51:05Z

src/DDTrace/Span.php

-            );
+        foreach ($tags as $key => $value) {
+            if ($key !== (string) $key) {
+                throw new InvalidArgumentException(


I think you should start to scope exceptions to the context of this library. A lot of client code tend to use catch all exceptions and you have this opportunity to introduce semantic exceptions too.

kevinlebrun · 2018-02-21T16:55:43Z

src/DDTrace/Span.php

@@ -249,9 +242,11 @@ public function setError($e)

        if (($e instanceof Exception) || ($e instanceof Throwable)) {


From http://php.net/manual/en/class.throwable.php

PHP classes cannot implement the Throwable interface directly, and must instead extend Exception.

Is it not enough to typehint for Exception ?

Throwable comes in PHP 7 and is meant for errors and exceptions. In PHP 5.6 there is not Throwable interface so we include it with the polifyll but need to check for both.

Oh ok, good to know! I didn't see the new Error object in PHP 7.

kevinlebrun · 2018-02-21T17:05:05Z

src/DDTrace/Tracer.php

+
+        $tracesToBeSent = [];
+
+        foreach ($this->traces as $trace) {


It may be overkill but I see a case for a Traces object which basically is a collection that implements this filtering logic.

I like the idea but I would really prefer to keep an array for performance issues. Having a TraceCollection object is a great idea but such a collection would introduce an immutable style that adds some performance overhead. I isolated the shifting (filtering + removing) logic to a private method tho.

kevinlebrun · 2018-02-21T17:06:16Z

tests/Unit/SpanTest.php

@@ -13,28 +13,39 @@
    const NAME = 'test_span';


It should be renamed into OPERATION_NAME for consistency.

clutchski · 2018-02-22T15:30:41Z

src/DDTrace/Span.php

-        }
+        foreach ($tags as $key => $value) {
+            if ($key !== (string) $key) {
+                throw InvalidSpanArgument::forTagKey($key);


Will this crash a user program? I'm more in favour I think of letting it pass and logging a warning or using whatever the string representation is.

Agreed. In all other languages we avoid raising exceptions from our tracing library (even if it's legit when designing a component that can fail). We should consider the library as a tool that you install and never impact your application, even if used "wrongly". In C# we did the same adding log for invalid arguments.

Bear in mind that if this is a hot-path in users' app (i.e. SetTag for each request), we may spam users' logs, so a rate-limited logger is eventually required.

I have mixed feelings here. InvalidSpanArgument extends InvalidArgumentException which is a DomainException: exceptions that should not come up in production (as opposed to RuntimeException which are exceptions coming from the runtime). In the other hand, framework instrumentation libraries should have this issue well controlled as you most likely use standard OpenTracing tags. Finally, this is about the key of the tag, not the value so in 99% of the cases, this will be a harcoded or fixed value (from OT tags) so I really see this as a legit exception.

As a note, framework instrumentation libraries will probably do the try/catch in order to decide what to do with this exception, adding a logger here is not only adding a dependency on the tracer but adding a logger reference on every span. In addition, OpenTracing itself throws some exceptions when things that should be checked statically are not (like the key of a tag being an string) so try/catch in middlewares/hooks is required.

What do you think?

OK I see, we can proceed that way then since it's not a RuntimeException.

palazzem

Good to me!

palazzem · 2018-02-26T21:52:31Z

src/DDTrace/Span.php

-        }
+        foreach ($tags as $key => $value) {
+            if ($key !== (string) $key) {
+                throw InvalidSpanArgument::forTagKey($key);


OK I see, we can proceed that way then since it's not a RuntimeException.

jcchavezs added 2 commits February 16, 2018 08:32

Adds opentracing compatibility.

0795580

Adds tests for the propagation.

6f16ae0

palazzem self-requested a review February 16, 2018 14:07

palazzem added the 🍏 core Changes to the core tracing functionality label Feb 16, 2018

palazzem added this to the 0.1.0 milestone Feb 16, 2018

Removes logger dependency and fixes dev autoloading.

dc2f460

jcchavezs force-pushed the adds_tracing_ot_compliant branch from 8dd3e94 to dc2f460 Compare February 16, 2018 14:28

jcchavezs mentioned this pull request Feb 16, 2018

Adds encoders. #8

Merged

palazzem requested a review from vlad-mh February 21, 2018 10:23

vlad-mh suggested changes Feb 21, 2018

View reviewed changes

kevinlebrun reviewed Feb 21, 2018

View reviewed changes

Adds improvements based on feedback.

d405aaf

jcchavezs force-pushed the adds_tracing_ot_compliant branch from 44f8a9f to d405aaf Compare February 22, 2018 13:57

vlad-mh approved these changes Feb 22, 2018

View reviewed changes

clutchski reviewed Feb 22, 2018

View reviewed changes

palazzem approved these changes Feb 26, 2018

View reviewed changes

jcchavezs merged commit 7a3c8b1 into master Feb 27, 2018

jcchavezs deleted the adds_tracing_ot_compliant branch March 21, 2018 07:14

derickr mentioned this pull request Dec 7, 2023

[Bug]: Segmentation fault when running symfony/console help with Xdebug 3.3.0 enabled #2415

Closed

elzekool mentioned this pull request Apr 17, 2024

[Bug]: CLI PHP Processes do not stop and with Apache (mod_php) the connection is closed unexpectedly #2629

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds opentracing compatibility. #7

Adds opentracing compatibility. #7

jcchavezs commented Feb 16, 2018

vlad-mh left a comment

vlad-mh Feb 21, 2018

jcchavezs Feb 21, 2018

vlad-mh Feb 21, 2018

vlad-mh Feb 21, 2018

jcchavezs Feb 21, 2018

vlad-mh Feb 21, 2018 •

edited

Loading

jcchavezs Feb 22, 2018

vlad-mh Feb 21, 2018

jcchavezs Feb 21, 2018

kevinlebrun left a comment

kevinlebrun Feb 21, 2018

kevinlebrun Feb 21, 2018

kevinlebrun Feb 21, 2018

jcchavezs Feb 21, 2018

kevinlebrun Feb 21, 2018

kevinlebrun Feb 21, 2018

jcchavezs Feb 21, 2018 •

edited

Loading

kevinlebrun Feb 22, 2018

kevinlebrun Feb 21, 2018 •

edited

Loading

jcchavezs Feb 22, 2018

kevinlebrun Feb 21, 2018

clutchski Feb 22, 2018 •

edited

Loading

palazzem Feb 22, 2018

jcchavezs Feb 22, 2018 •

edited

Loading

palazzem Feb 26, 2018

palazzem left a comment

palazzem Feb 26, 2018

		@@ -249,9 +242,11 @@ public function setError($e)

		if (($e instanceof Exception) \|\| ($e instanceof Throwable)) {

Adds opentracing compatibility. #7

Adds opentracing compatibility. #7

Conversation

jcchavezs commented Feb 16, 2018

vlad-mh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vlad-mh Feb 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinlebrun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcchavezs Feb 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinlebrun Feb 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clutchski Feb 22, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcchavezs Feb 22, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

palazzem left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vlad-mh Feb 21, 2018 •

edited

Loading

jcchavezs Feb 21, 2018 •

edited

Loading

kevinlebrun Feb 21, 2018 •

edited

Loading

clutchski Feb 22, 2018 •

edited

Loading

jcchavezs Feb 22, 2018 •

edited

Loading