profiler: add enable flag to control profiler activation #2840
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
nsrip-dd
reviewed
Sep 3, 2024
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 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. |
this is more consistent with the env var that is controlling this
nsrip-dd
approved these changes
Oct 25, 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR introduces a new environment variable
DD_PROFILING_ENABLEDto control the profiler's behavior in a way similar toDD_TRACE_ENABLED. By default,DD_PROFILING_ENABLEDis set totrue, meaning profiling will be enabled ifprofiler.Start()is called in the application code. IfDD_PROFILING_ENABLEDis set tofalse, profiling will be disabled even ifprofiler.Start()is called. This allows the application code to always callprofiler.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:
DD_PROFILING_ENABLEDenvironment variable.Start functionto skip profiling ifenablefield in profiler config isfalse.DD_PROFILING_ENABLEDinoptions_test.goandprofiler_test.go.Reviewer's Checklist