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

Properly parent lazily loaded module imports. #446

Merged
merged 3 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 10 additions & 5 deletions datadog_lambda/cold_start.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
_cold_start = True
_proactive_initialization = False
_lambda_container_initialized = False
_tracer = None


def set_cold_start(init_timestamp_ns):
Expand All @@ -18,6 +19,7 @@ def set_cold_start(init_timestamp_ns):
global _cold_start
global _lambda_container_initialized
global _proactive_initialization
global _tracer
if not _lambda_container_initialized:
now = time.time_ns()
if (now - init_timestamp_ns) // 1_000_000_000 > 10:
Expand All @@ -29,6 +31,7 @@ def set_cold_start(init_timestamp_ns):
_cold_start = False
_proactive_initialization = False
_lambda_container_initialized = True
from ddtrace import tracer as _tracer
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't know that you could just assign a value by doing an as wow



def is_cold_start():
Expand Down Expand Up @@ -62,6 +65,9 @@ def __init__(self, module_name, full_file_path, start_time_ns, end_time_ns=None)
self.start_time_ns = start_time_ns
self.end_time_ns = end_time_ns
self.children = []
self.context = None
if _lambda_container_initialized:
self.context = _tracer.context_provider.active()


root_nodes: List[ImportNode] = []
Expand All @@ -70,10 +76,8 @@ def __init__(self, module_name, full_file_path, start_time_ns, end_time_ns=None)


def reset_node_stacks():
global root_nodes
root_nodes = []
global import_stack
import_stack = []
root_nodes.clear()
Comment on lines 78 to +79
Copy link
Contributor

Choose a reason for hiding this comment

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

why are we removing the globals?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question. Replacing the lists with new ones was causing my test to fail because somewhere we're holding onto an old reference to these objects. The correct solution is to just remove all the stuff from inside the list.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yet, this would create an O(n) complexity instead of O(1) of reassigning right? Although I guess we'd have the remaining O(n) space in the wild while reassigning. I tried researching which was the best solution for this, but theres like 5 ways of doing it. So I'll take this one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This method does not do an allocation where as the previous did.

import_stack.clear()


def push_node(module_name, file_path):
Expand Down Expand Up @@ -183,7 +187,8 @@ def trace(self, root_nodes: List[ImportNode] = root_nodes):
cold_start_span = self.create_cold_start_span(cold_start_span_start_time_ns)
while root_nodes:
root_node = root_nodes.pop()
self.trace_tree(root_node, cold_start_span)
parent = root_node.context or cold_start_span
self.trace_tree(root_node, parent)
self.finish_span(cold_start_span, cold_start_span_end_time_ns)

def trace_tree(self, import_node: ImportNode, parent_span):
Expand Down
46 changes: 44 additions & 2 deletions tests/test_cold_start.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import os
import time
import unittest
import datadog_lambda.cold_start as cold_start

from sys import modules, meta_path
import os
from unittest.mock import MagicMock

import datadog_lambda.cold_start as cold_start
import datadog_lambda.wrapper as wrapper


class TestColdStartTracingSetup(unittest.TestCase):
def test_proactive_init(self):
Expand Down Expand Up @@ -234,3 +237,42 @@ def test_trace_ignore_libs(self):
self.cold_start_tracer.trace(nodes)
self.mock_activate.assert_called_once_with(self.mock_trace_ctx)
self.assertEqual(self.output_spans, ["node_0", "unittest_cold_start"])


def test_lazy_loaded_package_imports(monkeypatch):

spans = []

def finish(span):
spans.append(span)

monkeypatch.setattr(wrapper.tracer, "_on_span_finish", finish)
monkeypatch.setattr(wrapper, "is_new_sandbox", lambda: True)
monkeypatch.setattr("datadog_lambda.wrapper.dd_tracing_enabled", True)
monkeypatch.setenv(
"DD_COLD_START_TRACE_SKIP_LIB", "ddtrace.contrib.logging,datadog_lambda.wrapper"
)
monkeypatch.setenv("DD_MIN_COLD_START_DURATION", "0")

@wrapper.datadog_lambda_wrapper
def handler(event, context):
import tabnanny

lambda_context = MagicMock()
lambda_context.invoked_function_arn = (
"arn:aws:lambda:us-west-1:123457598159:function:python-layer-test:1"
)

handler.cold_start_tracing = True
handler({}, lambda_context)

function_span = import_span = None
for span in spans:
if span.resource == "tabnanny":
import_span = span
elif span.name == "aws.lambda":
function_span = span

assert function_span is not None
assert import_span is not None
assert import_span.parent_id == function_span.span_id