fix(python): ignore native in ffi (#131)

Author: korniltsev

pyroscope_cli/src/core/profiler.rs

@@ -63,6 +63,13 @@ impl Profiler {
                     .gil_only(pyspy_gil)
                     .native(pyspy_native);
 
+                if blocking {
+                    log::warn!("blocking is not recommended for production use");
+                }
+                if pyspy_native && !blocking {
+                    log::warn!("native profiling is not supported without blocking");
+                }
+
                 let backend = pyspy_backend(config);
 
                 let mut builder = PyroscopeAgent::default_builder();

pyroscope_ffi/python/README.md

@@ -47,7 +47,6 @@ pyroscope.configure(
   sample_rate         = 100, # default is 100
   detect_subprocesses = False, # detect subprocesses started by the main process; default is False
   oncpu               = True # report cpu time only; default is True
-  native              = False # profile native extensions; default is False
   gil_only            = True # only include traces for threads that are holding on to the Global Interpreter Lock; default is True
   log_level           = "info" # default is info, possible values: trace, debug, info, warn, error and critical 
   tags           = {

pyroscope_ffi/python/lib/src/lib.rs

@@ -49,7 +49,6 @@ pub extern "C" fn initialize_agent(
     sample_rate: u32,
     detect_subprocesses: bool,
     oncpu: bool,
-    native: bool,
     gil_only: bool,
     report_pid: bool,
     report_thread_id: bool,
@@ -117,7 +116,7 @@ pub extern "C" fn initialize_agent(
         .lock_process(false)
         .detect_subprocesses(detect_subprocesses)
         .oncpu(oncpu)
-        .native(native)
+        .native(false)
         .gil_only(gil_only);
 
     // Report the PID.

pyroscope_ffi/python/pyroscope/__init__.py

@@ -18,7 +18,7 @@ def configure(
         sample_rate=100,
         detect_subprocesses=False,
         oncpu=True,
-        native=False,
+        native=None,
         gil_only=True,
         report_pid=False,
         report_thread_id=False,
@@ -32,6 +32,9 @@ def configure(
         warnings.warn("app_name is deprecated, use application_name", DeprecationWarning)
         application_name = app_name
 
+    if native is not None:
+        warnings.warn("native is deprecated and not supported", DeprecationWarning)
+
     if enable_logging:
         logger = logging.getLogger()
         log_level = logger.getEffectiveLevel()
@@ -46,7 +49,6 @@ def configure(
         sample_rate,
         detect_subprocesses,
         oncpu,
-        native,
         gil_only,
         report_pid,
         report_thread_id,