Add config setting for sklearn inference event capture. (#706)

* Add sklearn to tox * Add function traces around model methods * Support Python 2.7 & 3.7 sklearn * Add test for multiple calls to model method * Fixup: add comments & organize * Refactor * Follow two digit convention * Make if-else a one-liner * Abstract to re-usable instrumentation function * Add ML inference event capture config setting. * [Mega-Linter] Apply linters fixes * Fixup: remove component_sklearn files * Add high security mode testing for ML events setting. * [Mega-Linter] Apply linters fixes Co-authored-by: Hannah Stepanek <hstepanek@newrelic.com> Co-authored-by: umaannamalai <umaannamalai@users.noreply.github.com>
newrelic · Jan 3, 2023 · d190975 · d190975
1 parent 9168a7e
commit d190975
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/newrelic/config.py b/newrelic/config.py
@@ -539,6 +539,8 @@ def _process_configuration(section):
     _process_setting(section, "application_logging.metrics.enabled", "getboolean", None)
     _process_setting(section, "application_logging.local_decorating.enabled", "getboolean", None)
 
+    _process_setting(section, "machine_learning.inference_event_value.enabled", "getboolean", None)
+
 
 # Loading of configuration from specified file and for specified
 # deployment environment. Can also indicate whether configuration
@@ -875,6 +877,10 @@ def apply_local_high_security_mode_setting(settings):
         settings.application_logging.forwarding.enabled = False
         _logger.info(log_template, "application_logging.forwarding.enabled", True, False)
 
+    if settings.machine_learning.inference_event_value.enabled:
+        settings.machine_learning.inference_event_value.enabled = False
+        _logger.info(log_template, "machine_learning.inference_event_value.enabled", True, False)
+
     return settings
 
 

diff --git a/newrelic/core/agent_protocol.py b/newrelic/core/agent_protocol.py
@@ -144,6 +144,7 @@ class AgentProtocol(object):
         "strip_exception_messages.enabled",
         "custom_insights_events.enabled",
         "application_logging.forwarding.enabled",
+        "machine_learning.inference_event_value.enabled",
     )
 
     LOGGER_FUNC_MAPPING = {

diff --git a/newrelic/core/config.py b/newrelic/core/config.py
@@ -121,6 +121,14 @@ class GCRuntimeMetricsSettings(Settings):
     enabled = False
 
 
+class MachineLearningSettings(Settings):
+    pass
+
+
+class MachineLearningInferenceEventValueSettings(Settings):
+    pass
+
+
 class CodeLevelMetricsSettings(Settings):
     pass
 
@@ -359,6 +367,8 @@ class EventHarvestConfigHarvestLimitSettings(Settings):
 _settings.application_logging.forwarding = ApplicationLoggingForwardingSettings()
 _settings.application_logging.metrics = ApplicationLoggingMetricsSettings()
 _settings.application_logging.local_decorating = ApplicationLoggingLocalDecoratingSettings()
+_settings.machine_learning = MachineLearningSettings()
+_settings.machine_learning.inference_event_value = MachineLearningInferenceEventValueSettings()
 _settings.attributes = AttributesSettings()
 _settings.gc_runtime_metrics = GCRuntimeMetricsSettings()
 _settings.code_level_metrics = CodeLevelMetricsSettings()
@@ -821,6 +831,9 @@ def default_host(license_key):
 _settings.application_logging.local_decorating.enabled = _environ_as_bool(
     "NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED", default=False
 )
+_settings.machine_learning.inference_event_value.enabled = _environ_as_bool(
+    "NEW_RELIC_MACHINE_LEARNING_INFERENCE_EVENT_VALUE_ENABLED", default=True
+)
 
 
 def global_settings():

diff --git a/tests/agent_features/test_high_security_mode.py b/tests/agent_features/test_high_security_mode.py
@@ -79,6 +79,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": True,
+        "machine_learning.inference_event_value.enabled": True,
     },
     {
         "high_security": False,
@@ -88,6 +89,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": False,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": True,
+        "machine_learning.inference_event_value.enabled": True,
     },
     {
         "high_security": False,
@@ -97,6 +99,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": False,
         "application_logging.forwarding.enabled": False,
+        "machine_learning.inference_event_value.enabled": False,
     },
     {
         "high_security": False,
@@ -106,6 +109,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": False,
         "message_tracer.segment_parameters_enabled": False,
         "application_logging.forwarding.enabled": False,
+        "machine_learning.inference_event_value.enabled": False,
     },
 ]
 
@@ -118,6 +122,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": False,
+        "machine_learning.inference_event_value.enabled": False,
     },
     {
         "high_security": True,
@@ -127,6 +132,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": False,
+        "machine_learning.inference_event_value.enabled": False,
     },
     {
         "high_security": True,
@@ -136,6 +142,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": False,
+        "machine_learning.inference_event_value.enabled": False,
     },
     {
         "high_security": True,
@@ -145,6 +152,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": True,
+        "machine_learning.inference_event_value.enabled": True,
     },
     {
         "high_security": True,
@@ -154,6 +162,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": True,
         "application_logging.forwarding.enabled": True,
+        "machine_learning.inference_event_value.enabled": True,
     },
     {
         "high_security": True,
@@ -163,6 +172,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": True,
         "message_tracer.segment_parameters_enabled": False,
         "application_logging.forwarding.enabled": True,
+        "machine_learning.inference_event_value.enabled": True,
     },
     {
         "high_security": True,
@@ -172,6 +182,7 @@ def test_hsm_configuration_default():
         "custom_insights_events.enabled": False,
         "message_tracer.segment_parameters_enabled": False,
         "application_logging.forwarding.enabled": True,
+        "machine_learning.inference_event_value.enabled": True,
     },
 ]
 
@@ -196,6 +207,7 @@ def test_local_config_file_override_hsm_disabled(settings):
     original_custom_events = settings.custom_insights_events.enabled
     original_message_segment_params_enabled = settings.message_tracer.segment_parameters_enabled
     original_application_logging_forwarding_enabled = settings.application_logging.forwarding.enabled
+    original_machine_learning_inference_event_value_enabled = settings.machine_learning.inference_event_value.enabled
 
     apply_local_high_security_mode_setting(settings)
 
@@ -205,6 +217,10 @@ def test_local_config_file_override_hsm_disabled(settings):
     assert settings.custom_insights_events.enabled == original_custom_events
     assert settings.message_tracer.segment_parameters_enabled == original_message_segment_params_enabled
     assert settings.application_logging.forwarding.enabled == original_application_logging_forwarding_enabled
+    assert (
+        settings.machine_learning.inference_event_value.enabled
+        == original_machine_learning_inference_event_value_enabled
+    )
 
 
 @parameterize_hsm_local_config(_hsm_local_config_file_settings_enabled)
@@ -217,6 +233,7 @@ def test_local_config_file_override_hsm_enabled(settings):
     assert settings.custom_insights_events.enabled is False
     assert settings.message_tracer.segment_parameters_enabled is False
     assert settings.application_logging.forwarding.enabled is False
+    assert settings.machine_learning.inference_event_value.enabled is False
 
 
 _server_side_config_settings_hsm_disabled = [
@@ -228,6 +245,7 @@ def test_local_config_file_override_hsm_enabled(settings):
             "strip_exception_messages.enabled": True,
             "custom_insights_events.enabled": False,
             "application_logging.forwarding.enabled": False,
+            "machine_learning.inference_event_value.enabled": False,
         },
         {
             "agent_config": {
@@ -236,6 +254,7 @@ def test_local_config_file_override_hsm_enabled(settings):
                 "strip_exception_messages.enabled": False,
                 "custom_insights_events.enabled": True,
                 "application_logging.forwarding.enabled": True,
+                "machine_learning.inference_event_value.enabled": True,
             },
         },
     ),
@@ -247,6 +266,7 @@ def test_local_config_file_override_hsm_enabled(settings):
             "strip_exception_messages.enabled": False,
             "custom_insights_events.enabled": True,
             "application_logging.forwarding.enabled": True,
+            "machine_learning.inference_event_value.enabled": True,
         },
         {
             "agent_config": {
@@ -255,6 +275,7 @@ def test_local_config_file_override_hsm_enabled(settings):
                 "strip_exception_messages.enabled": True,
                 "custom_insights_events.enabled": False,
                 "application_logging.forwarding.enabled": False,
+                "machine_learning.inference_event_value.enabled": False,
             },
         },
     ),
@@ -269,6 +290,7 @@ def test_local_config_file_override_hsm_enabled(settings):
             "strip_exception_messages.enabled": True,
             "custom_insights_events.enabled": False,
             "application_logging.forwarding.enabled": False,
+            "machine_learning.inference_event_value.enabled": False,
         },
         {
             "high_security": True,
@@ -277,12 +299,14 @@ def test_local_config_file_override_hsm_enabled(settings):
             "strip_exception_messages.enabled": True,
             "custom_insights_events.enabled": False,
             "application_logging.forwarding.enabled": False,
+            "machine_learning.inference_event_value.enabled": False,
             "agent_config": {
                 "capture_params": False,
                 "transaction_tracer.record_sql": "obfuscated",
                 "strip_exception_messages.enabled": True,
                 "custom_insights_events.enabled": False,
                 "application_logging.forwarding.enabled": False,
+                "machine_learning.inference_event_value.enabled": False,
             },
         },
     ),
@@ -294,6 +318,7 @@ def test_local_config_file_override_hsm_enabled(settings):
             "strip_exception_messages.enabled": True,
             "custom_insights_events.enabled": False,
             "application_logging.forwarding.enabled": False,
+            "machine_learning.inference_event_value.enabled": False,
         },
         {
             "high_security": True,
@@ -302,12 +327,14 @@ def test_local_config_file_override_hsm_enabled(settings):
             "strip_exception_messages.enabled": True,
             "custom_insights_events.enabled": False,
             "application_logging.forwarding.enabled": False,
+            "machine_learning.inference_event_value.enabled": False,
             "agent_config": {
                 "capture_params": True,
                 "transaction_tracer.record_sql": "raw",
                 "strip_exception_messages.enabled": False,
                 "custom_insights_events.enabled": True,
                 "application_logging.forwarding.enabled": True,
+                "machine_learning.inference_event_value.enabled": True,
             },
         },
     ),
@@ -328,6 +355,7 @@ def test_remote_config_fixups_hsm_disabled(local_settings, server_settings):
     original_strip_messages = agent_config["strip_exception_messages.enabled"]
     original_custom_events = agent_config["custom_insights_events.enabled"]
     original_log_forwarding = agent_config["application_logging.forwarding.enabled"]
+    original_machine_learning_events = agent_config["machine_learning.inference_event_value.enabled"]
 
     _settings = global_settings()
     settings = override_generic_settings(_settings, local_settings)(AgentProtocol._apply_high_security_mode_fixups)(
@@ -343,6 +371,7 @@ def test_remote_config_fixups_hsm_disabled(local_settings, server_settings):
     assert agent_config["strip_exception_messages.enabled"] == original_strip_messages
     assert agent_config["custom_insights_events.enabled"] == original_custom_events
     assert agent_config["application_logging.forwarding.enabled"] == original_log_forwarding
+    assert agent_config["machine_learning.inference_event_value.enabled"] == original_machine_learning_events
 
 
 @pytest.mark.parametrize("local_settings,server_settings", _server_side_config_settings_hsm_enabled)
@@ -365,12 +394,14 @@ def test_remote_config_fixups_hsm_enabled(local_settings, server_settings):
     assert "strip_exception_messages.enabled" not in settings
     assert "custom_insights_events.enabled" not in settings
     assert "application_logging.forwarding.enabled" not in settings
+    assert "machine_learning.inference_event_value.enabled" not in settings
 
     assert "capture_params" not in agent_config
     assert "transaction_tracer.record_sql" not in agent_config
     assert "strip_exception_messages.enabled" not in agent_config
     assert "custom_insights_events.enabled" not in agent_config
     assert "application_logging.forwarding.enabled" not in agent_config
+    assert "machine_learning.inference_event_value.enabled" not in agent_config
 
 
 def test_remote_config_hsm_fixups_server_side_disabled():