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.

Sign up for GitHub

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

Jump to bottom

Add Custom Instrumentation Documentation #1942

Merged

bwoebi merged 28 commits into master from alex/doc_custom_instrumentation

Mar 10, 2023

Contributor

PROFeNoM commented Feb 27, 2023 •

edited by bwoebi

Loading

Description

Add documentation for the function and classes declared in ddtrace.c, related to custom instrumentation.

Fixes #1574.

As part of this pull request, by necessity, we are moving to TypeError'ing out on bad parameters to DDTrace functions, see also 24f8fa3.

Readiness checklist

(only for Members) Changelog has been added to the release document.
Tests added for this feature/bug.

Reviewer checklist

Appropriate labels assigned.
Milestone is set.
Changelog has been added to the release document. For community contributors the reviewer is in charge of this task.


          Add Custom Instrumentation Documentation

f9f6197

PROFeNoM requested a review from a team as a code owner

February 27, 2023 14:52

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php

+                  function set_user(string $userId, ?array $metadata = null, ?bool $propagate = null): void {}
+                  /**
+                   * Get the value of a DD environment variable

Collaborator

bwoebi Feb 27, 2023

Suggested change

      
                 * Get the value of a DD environment variable
          
                 * Get the parsed value of a DD environment variable

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

Collaborator

bwoebi commented Feb 27, 2023

Can you please consistently leave a blank line in the docblocks between the description and the first @-line?

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

bwoebi reviewed

View reviewed changes

ext/ddtrace.stub.php Outdated Show resolved Hide resolved

PROFeNoM and others added 14 commits

March 2, 2023 13:54


          [WIP] Should pass C test for PHP 7.2+

115ff43

Some tests are still failing on PHP 7.0 and 7.1. I'm working on it.


          Change readonly macros compatibility

37ff51c


          Change some functions' return type to handle unexpected parameters

47ef0d9

Note: There may be even more functions with this issue


          Define macro introduced with last commit stub changes

f3825a0


          Change ZVAL_EMPTY_ARRAY version compatibility

d7e1aaa


          Fix linting compliance and some return types

cfa77bd

Note: There are still some core dump issues in api randomized stress tests


          Should fix c tests in PHP > 7.4

d115bdf


          Change SpanData registration process in C for PHP < 8

6acbde8

Note: The last commit introduced a fatal error (Internal zval's can't be arrays, objects or resources in Unknown on line 0) that could be observed in the c tests in the 7.x versions of PHP. As a result, functions weren't defined.


          Fix linting issues

11793be


          Fix Static Analysis 71

0519ca2


          Add more default values to SpanData

6b4c80c

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>


          Fix some tests

603cc28

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>


          remove if for span data

9d9ae49

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>


          Fix uninitialized value usage

61a6ac3

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>

bwoebi force-pushed the alex/doc_custom_instrumentation branch 4 times, most recently from b9d1a39 to 24f8fa3 Compare

March 8, 2023 12:55


          Transition away from being quiet on bad argument types

955d578

This is primarily motivated by PHP 8.1 strongly enforcing types declared by the arginfos. Given the stubs, we now have full arginfos and PHP becomes much more picky.
This is a good thing though, so, we're going to eventually always throw TypeErrors.

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>

bwoebi force-pushed the alex/doc_custom_instrumentation branch from 24f8fa3 to 955d578 Compare

March 9, 2023 14:05

bwoebi added 4 commits

March 9, 2023 18:03


          Merge branch 'master' of github.com:DataDog/dd-trace-php into alex/do…

da99647

…c_custom_instrumentation


          Fix addref

5d045c5

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>


          Add docblocks for install_hook API

099117a

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>


          Cleanup

b7ac24e

Signed-off-by: Bob Weinand <bob.weinand@datadoghq.com>

bwoebi approved these changes

View reviewed changes

Collaborator

bwoebi left a comment

Thanks for all these docs :-)

bwoebi merged commit 78d08dc into master

bwoebi deleted the alex/doc_custom_instrumentation branch

March 10, 2023 11:17

This was referenced Mar 10, 2023

Bug: Invocable classes don't work #1790

Closed

Release 0.85.0 #1969

Merged

PROFeNoM mentioned this pull request

IDE auto-complete when using extension #664

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet