feat: add HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE flag (#6)

* docs: honeycomb attibution

* feat: add HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE flag

* ci: add flag

Author: wrn14897

README.md

@@ -4,6 +4,8 @@
 [![CircleCI](https://circleci.com/gh/hyperdxio/hyperdx-opentelemetry-python.svg?style=shield)](https://circleci.com/gh/hyperdxio/hyperdx-opentelemetry-python)
 [![PyPi](https://img.shields.io/pypi/v/hyperdx-opentelemetry)](https://pypi.org/project/hyperdx-opentelemetry/)
 
+> This project is a fork from https://github.com/honeycombio/honeycomb-opentelemetry-python
+
 **STATUS: this library is BETA.**
 You're welcome to try it, and let us know your feedback in the issues!
 

smoke-tests/docker-compose.yml

@@ -70,3 +70,4 @@ services:
       <<: *env_base
       HYPERDX_API_ENDPOINT: http://collector:4318
       OTEL_EXPORTER_OTLP_PROTOCOL: http/protobuf
+      HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE: 1

src/hyperdx/opentelemetry/manual.py

@@ -129,18 +129,20 @@ def client_response_hook(span: FastAPISpan, message: dict):
 
 
 def configure_custom_env_vars(options: HyperDXOptions, resource: Resource):
-    os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_REQUEST"] = os.getenv(
-        "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_REQUEST", ".*"
-    )
-    os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_RESPONSE"] = os.getenv(
-        "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_RESPONSE", ".*"
-    )
-    os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST"] = os.getenv(
-        "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST", ".*"
-    )
-    os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE"] = os.getenv(
-        "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE", ".*"
-    )
+    if options.enable_advanced_network_capture:
+        os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_REQUEST"] = os.getenv(
+            "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_REQUEST", ".*"
+        )
+        os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_RESPONSE"] = os.getenv(
+            "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_RESPONSE", ".*"
+        )
+        os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST"] = os.getenv(
+            "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST", ".*"
+        )
+        os.environ["OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE"] = os.getenv(
+            "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE", ".*"
+        )
+
     os.environ["OTEL_PYTHON_LOG_CORRELATION"] = os.getenv(
         "OTEL_PYTHON_LOG_CORRELATION", "true"
     )
@@ -152,7 +154,8 @@ def instrument_custom_libs(
     tracer_provider: TracerProvider,
     meter_provider: MeterProvider,
 ):
-    _instrument_urllib(options, tracer_provider, meter_provider)
-    _instrument_requests(options, tracer_provider, meter_provider)
-    _instrument_flask(options, tracer_provider, meter_provider)
-    _instrument_fastapi(options, tracer_provider, meter_provider)
+    if options.enable_advanced_network_capture:
+        _instrument_urllib(options, tracer_provider, meter_provider)
+        _instrument_requests(options, tracer_provider, meter_provider)
+        _instrument_flask(options, tracer_provider, meter_provider)
+        _instrument_fastapi(options, tracer_provider, meter_provider)

src/hyperdx/opentelemetry/options.py

@@ -21,6 +21,7 @@
 # Environment Variable Names
 DEBUG = "DEBUG"
 HYPERDX_ENABLE_LOCAL_VISUALIZATIONS = "HYPERDX_ENABLE_LOCAL_VISUALIZATIONS"
+HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE = "HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE"
 OTEL_SERVICE_VERSION = "OTEL_SERVICE_VERSION"
 SAMPLE_RATE = "SAMPLE_RATE"
 
@@ -52,6 +53,11 @@
     + "HYPERDX_ENABLE_LOCAL_VISUALIZATIONS environment variable. "
     + "Defaulting to false."
 )
+INVALID_LOCAL_ADVANCED_NETWORK_CAPTURE_ERROR = (
+    "Unable to parse "
+    + "HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE environment variable. "
+    + "Defaulting to false."
+)
 INVALID_LOGS_INSECURE_ERROR = (
     "Unable to parse " + "OTEL_EXPORTER_OTLP_LOGS_INSECURE. Defaulting to False."
 )
@@ -243,6 +249,7 @@ class HyperDXOptions:
     dataset = None
     metrics_dataset = None
     enable_local_visualizations = False
+    enable_advanced_network_capture = False
 
     # pylint: disable=too-many-locals,too-many-branches,too-many-statements
     def __init__(
@@ -271,6 +278,7 @@ def __init__(
         traces_exporter_protocol: str = None,
         metrics_exporter_protocol: str = None,
         logs_exporter_protocol: str = None,
+        enable_advanced_network_capture: bool = False,
     ):
         self.debug = parse_bool(DEBUG, (debug or False), INVALID_DEBUG_ERROR)
         if self.debug:
@@ -433,6 +441,12 @@ def __init__(
             INVALID_LOCAL_VIS_ERROR,
         )
 
+        self.enable_advanced_network_capture = parse_bool(
+            HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE,
+            enable_advanced_network_capture,
+            INVALID_LOCAL_ADVANCED_NETWORK_CAPTURE_ERROR,
+        )
+
     def get_traces_endpoint(self) -> str:
         """
         Returns the OTLP traces endpoint to send spans to.