Update the documentation before the 0.1.2 release by bmermet · Pull Request #31 · DataDog/dd-trace-dotnet

bmermet · 2018-01-22T10:22:38Z

This PR updates the documentation to account for the new APIs and document the usage of the ASP.NET Core integration.

palazzem

Left a couple of comments that may require one or two changes.

palazzem · 2018-01-22T10:44:48Z


-To get a tracer with default parameters (i.e. the agent endpoint set to `http://localhost:8126`, and the default service name set to the name of the AppDomain):
+To get a tracer with default parameters (i.e. the agent endpoint set to
+`http://localhost:8126`, and the default service name set to the name of the


Instead of describing here 2 default parameters, can we make a section about how to configure the tracer? would be great listing all the parameters explaining the default. Then with just one example you'll cover all of them. An example is what we did for Ruby: http://gems.datadoghq.com/trace/docs/#Configure_the_tracer

palazzem · 2018-01-22T10:49:50Z

-        return _headers[key];
-    }
+// Dispose closes the underlying span, this sets its duration and sends it to the agent (if you don't call Dispose the data will never be sent to Datadog)
+scope.Dispose();


the API here should not be scope.Close() as defined in other languages? https://github.com/opentracing/opentracing-java/blob/master/opentracing-api/src/main/java/io/opentracing/Scope.java

palazzem · 2018-01-22T10:51:01Z

-    // Your instrumented code
-}
+Span parent = tracer.StartSpan("Parent");
+Span child = tracer.StartSpan("Child", parent: parent.Context);


shouldn't be childOf just to make our nomenclature same as OpenTracing?

palazzem · 2018-01-22T10:51:55Z

    }
 };
-ITracer tracer = TracerFactory.GetTracer(serviceInfoList: serviceInfoList);
+Tracer tracer = Tracer.CreateTracer(serviceInfoList: serviceInfoList);


Tracer.Create ?

palazzem

LGTM! Great job!

…31) The loader hooks into the `JitCachedFunctionSearchStarted` profiler callback in order to selectively disable the NGen usage for one particular method that needs to be instrumented to inject the managed loader. This change improves the performance of that callback: * Superfluous allocations and string conversions are removed. * Once the function id of the target method is known, a fast path is taken, that avoids metadata loading and string comparisons and uses just 2 integer comparisons instead. In an ad-hoc test, a 15 sec execution of the Profiler's Computer demo resulted in a total of 686 invocations of `HandleJitCachedFunctionSearchStarted`, out of which 677 (=98.7%) ended up using the fast path.

…lTargetTokens (#31) * Simplified the DebuggerTokens according to the refactoring of the CallTargetTokens

…5808) ## Summary of changes Prevent deadlock betwen signal-based profilers (walltime/manual cpu profilers) and non-signal based profilers (exception, contention....) ## Reason for change When an exception occurs, the thread can be interrupted by a signal-based profiler (walltime/manual cpu). It can be interrupted while holding the lock used to update the `dl-iterate-phdr` cache. ``` Thread 18 (LWP 995): #0 __syscall_cp_c (nr=202, u=140244538814536, v=128, w=-1, x=0, y=0, z=0) at ./arch/x86_64/syscall_arch.h:61 #1 0x00007f8dba343ccd in __futex4_cp (to=0x0, val=-1, op=128, addr=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at src/thread/__timedwait.c:24 #2 __timedwait_cp (addr=addr@entry=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>, val=val@entry=-1, clk=clk@entry=0, at=at@entry=0x0, priv=priv@entry=128) at src/thread/__timedwait.c:52 #3 0x00007f8dba343d74 in __timedwait (addr=addr@entry=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>, val=-1, clk=clk@entry=0, at=at@entry=0x0, priv=128) at src/thread/__timedwait.c:68 #4 0x00007f8dba3463e6 in __pthread_rwlock_timedrdlock (at=<optimized out>, rw=<optimized out>) at src/thread/pthread_rwlock_timedrdlock.c:18 #5 __pthread_rwlock_timedrdlock (rw=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>, at=0x0) at src/thread/pthread_rwlock_timedrdlock.c:3 #6 0x00007f8d398f3ca8 in std::__glibcxx_rwlock_rdlock (__rwlock=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:73 #7 std::__shared_mutex_pthread::lock_shared (this=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:224 #8 std::shared_mutex::lock_shared (this=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:421 #9 std::shared_lock<std::shared_mutex>::shared_lock (this=0x7f4ca05a2ac0, __m=...) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:722 #10 LibrariesInfoCache::DlIteratePhdrImpl (this=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>, callback=0x7f8d3997d900 <_Ux86_64_dwarf_callback>, data=0x7f4ca05a2b20) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/LibrariesInfoCache.cpp:104 #11 0x00007f8d3997e4ee in _Ux86_64_dwarf_find_proc_info (as=0x7f8d39eb2a00 <local_addr_space>, ip=140246691112115, pi=0x7f4ca05a3170, need_unwind_info=1, arg=0x7f4ca05a3411) at /project/obj/libunwind-prefix/src/libunwind/src/dwarf/Gfind_proc_info-lsb.c:807 #12 0x00007f8d3997e690 in fetch_proc_info (c=0x7f4ca05a3018, ip=140246691112115) at /project/obj/libunwind-prefix/src/libunwind/src/dwarf/Gparser.c:473 #13 0x00007f8d3998113d in find_reg_state (sr=0x7f4ca05a2dc0, c=0x7f4ca05a3018) at /project/obj/libunwind-prefix/src/libunwind/src/dwarf/Gparser.c:1024 #14 _Ux86_64_dwarf_step (c=c@entry=0x7f4ca05a3018) at /project/obj/libunwind-prefix/src/libunwind/src/dwarf/Gparser.c:1069 #15 0x00007f8d3997d13a in _Ux86_64_step (cursor=0x7f4ca05a3018) at /project/obj/libunwind-prefix/src/libunwind/src/x86_64/Gstep.c:75 #16 0x00007f8d398f55c8 in LinuxStackFramesCollector::CollectStackManually (this=this@entry=0x7f8d392dc6d0, ctx=ctx@entry=0x7f4ca05a3880) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/LinuxStackFramesCollector.cpp:288 #17 0x00007f8d398f53dc in LinuxStackFramesCollector::CollectCallStackCurrentThread (this=this@entry=0x7f8d392dc6d0, ctx=ctx@entry=0x7f4ca05a3880) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/LinuxStackFramesCollector.cpp:227 #18 0x00007f8d398f4672 in LinuxStackFramesCollector::CollectStackSampleSignalHandler (signal=<optimized out>, info=<optimized out>, context=0x7f4ca05a3880) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/LinuxStackFramesCollector.cpp:373 #19 0x00007f8d398fb871 in ProfilerSignalManager::CallCustomHandler (this=0x7f8d39eaf928 <ProfilerSignalManager::Get(int)::signalManagers+1944>, signal=10, info=0x7f4ca05a39b0, context=0x7f4ca05a3880) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/ProfilerSignalManager.cpp:197 #20 ProfilerSignalManager::SignalHandler (signal=10, info=0x7f4ca05a39b0, context=0x7f4ca05a3880) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/ProfilerSignalManager.cpp:188 #21 <signal handler called> #22 __pthread_rwlock_unlock (rw=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at src/thread/pthread_rwlock_unlock.c:5 #23 0x00007f8d398f3bf9 in std::__glibcxx_rwlock_unlock (__rwlock=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:77 #24 std::__shared_mutex_pthread::unlock (this=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:208 #25 std::shared_mutex::unlock (this=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/shared_mutex:417 #26 std::unique_lock<std::shared_mutex>::unlock (this=0x7f4ca05a3e20) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/bits/unique_lock.h:194 #27 std::unique_lock<std::shared_mutex>::~unique_lock (this=0x7f4ca05a3e20) at /usr/lib/gcc/x86_64-alpine-linux-musl/10.3.1/../../../../include/c++/10.3.1/bits/unique_lock.h:103 #28 LibrariesInfoCache::UpdateCache (this=0x7f8d39eaf048 <LibrariesInfoCache::Get()::Instance>) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/LibrariesInfoCache.cpp:88 #29 0x00007f8d398f4e59 in LinuxStackFramesCollector::CollectStackSampleImplementation (this=0x7f8d3b91bc90, pThreadInfo=0x7f4ca06b9900, pHR=0x7f8d3a63c510, selfCollect=true) at /p--Type <RET> for more, q to quit, c to continue without paging-- roject/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/LinuxStackFramesCollector.cpp:100 #30 0x00007f8d399637ba in StackFramesCollectorBase::CollectStackSample (this=0x7f8d3b91bc90, pThreadInfo=0x7f4ca06b9900, pHR=0x7f4ca05a3fdc) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native/StackFramesCollectorBase.cpp:185 #31 0x00007f8d3992acb9 in ExceptionsProvider::OnExceptionThrown (this=0x7f8d392a7160, thrownObjectId=139969739182080) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native/ExceptionsProvider.cpp:149 #32 0x00007f8d39917045 in CorProfilerCallback::ExceptionThrown (this=0x7f8d392c0d20, thrownObjectId=139969739182080) at /project/profiler/src/ProfilerEngine/Datadog.Profiler.Native/CorProfilerCallback.cpp:1734 ``` ## Implementation details - move the call which updates the cache after acquiring the thread lock - call Update before sending signal ## Test coverage ## Other details

bmermet requested a review from palazzem January 22, 2018 10:22

bmermet added the area:docs label Jan 22, 2018

palazzem added this to the 0.1.2 milestone Jan 22, 2018

palazzem suggested changes Jan 22, 2018

View reviewed changes

bmermet added 3 commits January 22, 2018 13:56

Update the documentation

261d850

Add a paragraph on Asp.Net Core

bc0cf6e

Address Manu's comments

6b7573b

bmermet force-pushed the bmermet/updatedoc branch from eb4a2ca to 6b7573b Compare January 22, 2018 12:56

palazzem approved these changes Jan 22, 2018

View reviewed changes

palazzem merged commit 72011ec into master Jan 22, 2018

palazzem deleted the bmermet/updatedoc branch January 22, 2018 12:58

GreenMatan added a commit that referenced this pull request Jul 10, 2022

Simplified the DebuggerTokens according to the refactoring of the Cal…

69357ea

…lTargetTokens (#31) * Simplified the DebuggerTokens according to the refactoring of the CallTargetTokens

gleocadie mentioned this pull request Jan 19, 2023

Performance degradation in 2.21.0 #3625

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the documentation before the 0.1.2 release#31

Update the documentation before the 0.1.2 release#31
palazzem merged 3 commits intomasterfrom
bmermet/updatedoc

bmermet commented Jan 22, 2018

Uh oh!

palazzem left a comment

Uh oh!

palazzem Jan 22, 2018

Uh oh!

palazzem Jan 22, 2018

Uh oh!

bmermet Jan 22, 2018

Uh oh!

palazzem Jan 22, 2018

Uh oh!

bmermet Jan 22, 2018

Uh oh!

palazzem Jan 22, 2018

Uh oh!

bmermet Jan 22, 2018

Uh oh!

palazzem left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

bmermet commented Jan 22, 2018

Uh oh!

palazzem left a comment

Choose a reason for hiding this comment

Uh oh!

palazzem Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

palazzem Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

bmermet Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

palazzem Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

bmermet Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

palazzem Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

bmermet Jan 22, 2018

Choose a reason for hiding this comment

Uh oh!

palazzem left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants