Skip to content
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

PROF-8458: Enhance the way GC profiler is enabled #3807

Merged
merged 1 commit into from
Nov 20, 2023

Conversation

szegedi
Copy link
Contributor

@szegedi szegedi commented Nov 16, 2023

What does this PR do?

Rights the wrongs in the way GC profiler is enabled:

  • Setting DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED to any non-null value including 0 or false no longer enables it. Now only values 1 and true will work, as intended. 🤦
  • Can't set it anymore by explicitly including profiler type 'events' directly into the list of profilers.

Motivation

Use of the env var was buggy as it turned the profiler on as soon as the env var was non-null. We'll also need to use a proper config property timelineEnabled soon, so might as well introduce it already. Having an intermediate string specification ('events') is both unnecessary and allows for misconfiguration (e.g. turning it on while config.timelineEnabled is false)

Security

Datadog employees:

  • If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from @DataDog/security-design-and-guidance.
  • This PR doesn't touch any of that.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
szegedi Attila Szegedi
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
@szegedi szegedi requested a review from a team as a code owner November 16, 2023 16:28
Copy link

Overall package size

Self size: 5.56 MB
Deduped: 61.21 MB
No deduping: 61.97 MB

Dependency sizes

name version self size total size
@datadog/native-iast-taint-tracking 1.6.4 16.43 MB 16.44 MB
@datadog/native-appsec 4.0.0 14.83 MB 14.83 MB
@datadog/pprof 4.0.1 9.32 MB 10.16 MB
protobufjs 7.2.4 2.74 MB 6.52 MB
@datadog/native-iast-rewriter 2.2.1 2.27 MB 2.36 MB
@opentelemetry/core 1.14.0 872.87 kB 1.47 MB
@datadog/native-metrics 2.0.0 898.77 kB 1.3 MB
@opentelemetry/api 1.4.1 780.32 kB 780.32 kB
import-in-the-middle 1.4.2 41.4 kB 704.79 kB
pprof-format 2.0.7 588.12 kB 588.12 kB
msgpack-lite 0.1.26 201.16 kB 281.59 kB
opentracing 0.14.7 194.81 kB 194.81 kB
semver 7.5.4 93.4 kB 123.8 kB
@datadog/sketches-js 2.1.0 109.9 kB 109.9 kB
lodash.sortby 4.7.0 75.76 kB 75.76 kB
lru-cache 7.14.0 74.95 kB 74.95 kB
ipaddr.js 2.1.0 60.23 kB 60.23 kB
ignore 5.2.4 51.22 kB 51.22 kB
int64-buffer 0.1.10 49.18 kB 49.18 kB
istanbul-lib-coverage 3.2.0 29.34 kB 29.34 kB
lodash.uniq 4.5.0 25.01 kB 25.01 kB
limiter 1.1.5 23.17 kB 23.17 kB
dc-polyfill 0.1.2 22.77 kB 22.77 kB
retry 0.13.1 18.85 kB 18.85 kB
lodash.kebabcase 4.1.1 17.75 kB 17.75 kB
node-abort-controller 3.1.1 16.89 kB 16.89 kB
lodash.pick 4.4.0 16.33 kB 16.33 kB
jest-docblock 29.7.0 8.99 kB 12.76 kB
crypto-randomuuid 1.0.0 11.18 kB 11.18 kB
path-to-regexp 0.1.7 6.78 kB 6.78 kB
koalas 1.0.2 6.47 kB 6.47 kB
methods 1.1.2 5.29 kB 5.29 kB
module-details-from-path 1.0.3 4.47 kB 4.47 kB

🤖 This report was automatically generated by heaviest-objects-in-the-universe

Copy link

codecov bot commented Nov 16, 2023

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (7abbcc5) 85.25% compared to head (a4e727b) 85.26%.

Files Patch % Lines
packages/dd-trace/src/profiling/config.js 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3807      +/-   ##
==========================================
+ Coverage   85.25%   85.26%   +0.01%     
==========================================
  Files         230      230              
  Lines        9482     9482              
  Branches       33       33              
==========================================
+ Hits         8084     8085       +1     
+ Misses       1398     1397       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@nsavoire nsavoire left a comment

Choose a reason for hiding this comment

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

I like this new way of enabling timeline !

@szegedi szegedi merged commit 0054057 into master Nov 20, 2023
105 of 109 checks passed
@szegedi szegedi deleted the szegedi/PROF-8458-fix-enable branch November 20, 2023 15:59
This was referenced Nov 20, 2023
khanayan123 pushed a commit that referenced this pull request Jan 2, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
khanayan123 pushed a commit that referenced this pull request Jan 2, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
khanayan123 pushed a commit that referenced this pull request Jan 2, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
khanayan123 pushed a commit that referenced this pull request Jan 2, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
khanayan123 pushed a commit that referenced this pull request Jan 2, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
khanayan123 pushed a commit that referenced this pull request Jan 2, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
erikvanbrakel pushed a commit to mazedesignhq/dd-trace-js that referenced this pull request Jul 5, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
* `DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED=0` no longer enables it
* can't set it by including a profiler type `'events'` directly
* can only set it through either the env variable or options, with consistent results.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants