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

profiler: add enable flag to control profiler activation #2840

Merged
merged 8 commits into from
Oct 25, 2024

Conversation

korECM
Copy link
Contributor

@korECM korECM commented Aug 31, 2024

What does this PR do?

This PR introduces a new environment variable DD_PROFILING_ENABLED to control the profiler's behavior in a way similar to DD_TRACE_ENABLED. By default, DD_PROFILING_ENABLED is set to true, meaning profiling will be enabled if profiler.Start() is called in the application code. If DD_PROFILING_ENABLED is set to false, profiling will be disabled even if profiler.Start() is called. This allows the application code to always call profiler.Start() while dynamically adjusting profiling through the environment variable.

Motivation

Fixes #2834

The motivation for this PR is to simplify the control of profiling behavior across multiple applications. By introducing DD_PROFILING_ENABLED, developers can avoid the cumbersome task of managing environment variables within the application code and instead control profiling through a single environment variable.

Additional Information

This PR includes the following changes:

  • Addition of enable field in profiler config struct.
  • Update to defaultConfig function to read DD_PROFILING_ENABLED environment variable.
  • Conditional check in Start function to skip profiling if enable field in profiler config is false.
  • Unit tests for DD_PROFILING_ENABLED in options_test.go and profiler_test.go.

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • System-Tests covering this feature have been added and enabled with the va.b.c-dev version tag.
  • There is a benchmark for any new code, or changes to existing code.
  • If this interacts with the agent in a new way, a system test has been added.
  • Add an appropriate team label so this PR gets put in the right place for the release notes.
  • Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild.

Add a new 'enable' field to the profiler config, controlled by the
DD_PROFILING_ENABLED environment variable. This allows users to
disable profiling even when the Start() function is called.

The enable flag defaults to true, maintaining backwards compatibility.
When set to false, the profiler will not start, providing a simple way
to toggle profiling without code changes.

Update tests to cover the new functionality and add logging for the
new configuration option.
@korECM korECM requested a review from a team as a code owner August 31, 2024 08:33
Copy link
Member

@felixge felixge left a comment

Choose a reason for hiding this comment

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

LGTM. @nsrip-dd could you also take a look please? Kicking of a CI run now.

profiler/options.go Outdated Show resolved Hide resolved
profiler/profiler_test.go Show resolved Hide resolved
profiler/options.go Outdated Show resolved Hide resolved
profiler/options.go Outdated Show resolved Hide resolved
Updated profiler options to automatically enable profiling if the environment variable "DD_PROFILING_ENABLED" is set to "auto". This change delegates the decision to the Datadog admission controller when "auto" is specified.
Implemented a new test to verify that no profiles are received when the profiler is disabled. This helps ensure the profiler respects the DD_PROFILING_ENABLED environment variable.
@korECM
Copy link
Contributor Author

korECM commented Oct 14, 2024

Hi @felixge @nsrip-dd

I hope you're doing well! I noticed that my PR has been pending review for about a month. If you have some time, I would greatly appreciate it if you could take a look.

Thank you!

@felixge
Copy link
Member

felixge commented Oct 21, 2024

@korECM sorry about the delay here. I've blocked some time in my calendar tomorrow to follow up. Hopefully we can get this landed before end of week.

Copy link
Contributor

@nsrip-dd nsrip-dd left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! I'll let @felixge have one more pass then this should be good to land IMO

Copy link
Member

@felixge felixge left a comment

Choose a reason for hiding this comment

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

LGTM. I pushed two commits to address some NITs. @nsrip-dd please re-review and merge if those changes look okay. 🙇

@nsrip-dd nsrip-dd merged commit f126bcf into DataDog:main Oct 25, 2024
72 checks passed
@korECM korECM deleted the add-profiler-enable-env branch October 26, 2024 06:42
@felixge
Copy link
Member

felixge commented Oct 28, 2024

Thanks @korECM for contributing this 🙇. Sorry for the delays.

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

Successfully merging this pull request may close these issues.

proposal: adding DD_PROFILING_ENABLED environment variable to control profiling
3 participants