Skip to content

feat: Add env var to control sending telemetry to appinsights in functions worker #1621

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Feb 7, 2025
Merged

feat: Add env var to control sending telemetry to appinsights in functions worker #1621

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2467040
str
lzchen Oct 3, 2024
1ef8c76
change
lzchen Dec 12, 2024
2921117
otel
lzchen Dec 12, 2024
a69f01a
lint
lzchen Jan 2, 2025
c625306
Merge branch 'dev' of https://github.com/Azure/azure-functions-python…
lzchen Jan 2, 2025
b34fd26
test
lzchen Jan 2, 2025
5ba3131
changes
lzchen Feb 6, 2025
804cf6d
Merge branch 'dev' of https://github.com/Azure/azure-functions-python…
lzchen Feb 6, 2025
7894617
Update pyproject.toml
lzchen Feb 6, 2025
22c5d3d
fix test
lzchen Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions azure_functions_worker/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,20 @@
BASE_EXT_SUPPORTED_PY_MINOR_VERSION = 8

# Appsetting to turn on OpenTelemetry support/features
# Includes turning on Azure monitor distro to send telemetry to AppInsights
# A value of "true" enables the setting, defaults to "false"
PYTHON_ENABLE_OPENTELEMETRY = "PYTHON_ENABLE_OPENTELEMETRY"
PYTHON_ENABLE_OPENTELEMETRY_DEFAULT = False
PYTHON_ENABLE_OPENTELEMETRY_DEFAULT = "false"

# Appsetting to turn on ApplicationInsights support/features
# A value of "true" enables the setting, defaults to "false"
PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY = \
"PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY"
PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY_DEFAULT = "false"

# Appsetting to specify root logger name of logger to collect telemetry for
# Used by Azure monitor distro
PYTHON_AZURE_MONITOR_LOGGER_NAME = "PYTHON_AZURE_MONITOR_LOGGER_NAME"
PYTHON_AZURE_MONITOR_LOGGER_NAME_DEFAULT = ""
# Used by Azure monitor distro (Application Insights)
PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME = "PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME"
PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME_DEFAULT = ""

# Appsetting to specify AppInsights connection string
APPLICATIONINSIGHTS_CONNECTION_STRING = "APPLICATIONINSIGHTS_CONNECTION_STRING"
48 changes: 34 additions & 14 deletions azure_functions_worker/dispatcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@
APPLICATIONINSIGHTS_CONNECTION_STRING,
HTTP_URI,
METADATA_PROPERTIES_WORKER_INDEXED,
PYTHON_AZURE_MONITOR_LOGGER_NAME,
PYTHON_AZURE_MONITOR_LOGGER_NAME_DEFAULT,
PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME,
PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME_DEFAULT,
PYTHON_ENABLE_DEBUG_LOGGING,
PYTHON_ENABLE_INIT_INDEXING,
PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY,
PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY_DEFAULT,
PYTHON_ENABLE_OPENTELEMETRY,
PYTHON_ENABLE_OPENTELEMETRY_DEFAULT,
PYTHON_LANGUAGE_RUNTIME,
Expand Down Expand Up @@ -103,8 +105,10 @@ def __init__(self, loop: BaseEventLoop, host: str, port: int,
self._function_metadata_result = None
self._function_metadata_exception = None

# Used for checking if open telemetry is enabled
# Used for checking if appinsights is enabled
self._azure_monitor_available = False
# Used for checking if open telemetry is enabled
self._otel_libs_available = False
self._context_api = None
self._trace_context_propagator = None

Expand Down Expand Up @@ -318,8 +322,8 @@ def initialize_azure_monitor(self):
setting=APPLICATIONINSIGHTS_CONNECTION_STRING
),
logger_name=get_app_setting(
setting=PYTHON_AZURE_MONITOR_LOGGER_NAME,
default_value=PYTHON_AZURE_MONITOR_LOGGER_NAME_DEFAULT
setting=PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME,
default_value=PYTHON_APPLICATIONINSIGHTS_LOGGER_NAME_DEFAULT
),
)
self._azure_monitor_available = True
Expand Down Expand Up @@ -381,12 +385,24 @@ async def _handle__worker_init_request(self, request):
constants.RPC_HTTP_TRIGGER_METADATA_REMOVED: _TRUE,
constants.SHARED_MEMORY_DATA_TRANSFER: _TRUE,
}
if get_app_setting(setting=PYTHON_ENABLE_OPENTELEMETRY,
default_value=PYTHON_ENABLE_OPENTELEMETRY_DEFAULT):

opentelemetry_app_setting = get_app_setting(
setting=PYTHON_ENABLE_OPENTELEMETRY,
default_value=PYTHON_ENABLE_OPENTELEMETRY_DEFAULT,
)

appinsights_app_setting = get_app_setting(
setting=PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY,
default_value=PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY_DEFAULT,
)
if appinsights_app_setting and appinsights_app_setting.lower() == "true":
self.initialize_azure_monitor()

if self._azure_monitor_available:
capabilities[constants.WORKER_OPEN_TELEMETRY_ENABLED] = _TRUE
if opentelemetry_app_setting and opentelemetry_app_setting.lower() == "true":
self._otel_libs_available = True

if self._azure_monitor_available or self._otel_libs_available:
capabilities[constants.WORKER_OPEN_TELEMETRY_ENABLED] = _TRUE

if DependencyManager.should_load_cx_dependencies():
DependencyManager.prioritize_customer_dependencies()
Expand Down Expand Up @@ -662,7 +678,7 @@ async def _handle__invocation_request(self, request):
args[name] = bindings.Out()

if fi.is_async:
if self._azure_monitor_available:
if self._azure_monitor_available or self._otel_libs_available:
self.configure_opentelemetry(fi_context)

call_result = \
Expand Down Expand Up @@ -782,11 +798,15 @@ async def _handle__function_environment_reload_request(self, request):
if get_app_setting(
setting=PYTHON_ENABLE_OPENTELEMETRY,
default_value=PYTHON_ENABLE_OPENTELEMETRY_DEFAULT):
self._otel_libs_available = True
if get_app_setting(
setting=PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY,
default_value=PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY_DEFAULT):
self.initialize_azure_monitor()

if self._azure_monitor_available:
capabilities[constants.WORKER_OPEN_TELEMETRY_ENABLED] = (
_TRUE)
if self._azure_monitor_available or self._otel_libs_available:
capabilities[constants.WORKER_OPEN_TELEMETRY_ENABLED] = (
_TRUE)

if is_envvar_true(PYTHON_ENABLE_INIT_INDEXING):
try:
Expand Down Expand Up @@ -996,7 +1016,7 @@ def _run_sync_func(self, invocation_id, context, func, params):
# invocation_id from ThreadPoolExecutor's threads.
context.thread_local_storage.invocation_id = invocation_id
try:
if self._azure_monitor_available:
if self._azure_monitor_available or self._otel_libs_available:
self.configure_opentelemetry(context)
return ExtensionManager.get_sync_invocation_wrapper(context,
func)(params)
Expand Down
4 changes: 3 additions & 1 deletion azure_functions_worker/utils/app_setting_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
FUNCTIONS_WORKER_SHARED_MEMORY_DATA_TRANSFER_ENABLED,
PYTHON_ENABLE_DEBUG_LOGGING,
PYTHON_ENABLE_INIT_INDEXING,
PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY,
PYTHON_ENABLE_OPENTELEMETRY,
PYTHON_ENABLE_WORKER_EXTENSIONS,
PYTHON_ENABLE_WORKER_EXTENSIONS_DEFAULT,
Expand All @@ -29,7 +30,8 @@ def get_python_appsetting_state():
FUNCTIONS_WORKER_SHARED_MEMORY_DATA_TRANSFER_ENABLED,
PYTHON_SCRIPT_FILE_NAME,
PYTHON_ENABLE_INIT_INDEXING,
PYTHON_ENABLE_OPENTELEMETRY]
PYTHON_ENABLE_OPENTELEMETRY,
PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY]

app_setting_states = "".join(
f"{app_setting}: {current_vars[app_setting]} | "
Expand Down
120 changes: 114 additions & 6 deletions tests/unittests/test_opentelemetry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ def test_update_opentelemetry_status_import_error(self):
# Patch the built-in import mechanism
with patch('builtins.__import__', side_effect=ImportError):
self.dispatcher.update_opentelemetry_status()
# Verify that otel_libs_available is set to False due to ImportError
self.assertFalse(self.dispatcher._azure_monitor_available)
# Verify that context variables are None due to ImportError
self.assertIsNone(self.dispatcher._context_api)
self.assertIsNone(self.dispatcher._trace_context_propagator)

@patch('builtins.__import__')
def test_update_opentelemetry_status_success(
Expand Down Expand Up @@ -54,12 +55,12 @@ def test_initialize_azure_monitor_import_error(
with patch('builtins.__import__', side_effect=ImportError):
self.dispatcher.initialize_azure_monitor()
mock_update_ot.assert_called_once()
# Verify that otel_libs_available is set to False due to ImportError
# Verify that azure_monitor_available is set to False due to ImportError
self.assertFalse(self.dispatcher._azure_monitor_available)

@patch.dict(os.environ, {'PYTHON_ENABLE_OPENTELEMETRY': 'true'})
@patch.dict(os.environ, {'PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY': 'true'})
@patch('builtins.__import__')
def test_init_request_otel_capability_enabled_app_setting(
def test_init_request_initialize_azure_monitor_enabled_app_setting(
self,
mock_imports,
):
Expand All @@ -78,13 +79,15 @@ def test_init_request_otel_capability_enabled_app_setting(
self.assertEqual(init_response.worker_init_response.result.status,
protos.StatusResult.Success)

# Verify azure_monitor_available is set to True
self.assertTrue(self.dispatcher._azure_monitor_available)
# Verify that WorkerOpenTelemetryEnabled capability is set to _TRUE
capabilities = init_response.worker_init_response.capabilities
self.assertIn("WorkerOpenTelemetryEnabled", capabilities)
self.assertEqual(capabilities["WorkerOpenTelemetryEnabled"], "true")

@patch("azure_functions_worker.dispatcher.Dispatcher.initialize_azure_monitor")
def test_init_request_otel_capability_disabled_app_setting(
def test_init_request_initialize_azure_monitor_default_app_setting(
self,
mock_initialize_azmon,
):
Expand All @@ -103,8 +106,113 @@ def test_init_request_otel_capability_disabled_app_setting(
protos.StatusResult.Success)

# Azure monitor initialized not called
# Since default behavior is not enabled
mock_initialize_azmon.assert_not_called()

# Verify azure_monitor_available is set to False
self.assertFalse(self.dispatcher._azure_monitor_available)
# Verify that WorkerOpenTelemetryEnabled capability is not set
capabilities = init_response.worker_init_response.capabilities
self.assertNotIn("WorkerOpenTelemetryEnabled", capabilities)

@patch.dict(os.environ, {'PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY': 'false'})
@patch("azure_functions_worker.dispatcher.Dispatcher.initialize_azure_monitor")
def test_init_request_initialize_azure_monitor_disabled_app_setting(
self,
mock_initialize_azmon,
):

init_request = protos.StreamingMessage(
worker_init_request=protos.WorkerInitRequest(
host_version="2.3.4",
function_app_directory=str(FUNCTION_APP_DIRECTORY)
)
)

init_response = self.loop.run_until_complete(
self.dispatcher._handle__worker_init_request(init_request))

self.assertEqual(init_response.worker_init_response.result.status,
protos.StatusResult.Success)

# Azure monitor initialized not called
mock_initialize_azmon.assert_not_called()

# Verify azure_monitor_available is set to False
self.assertFalse(self.dispatcher._azure_monitor_available)
# Verify that WorkerOpenTelemetryEnabled capability is not set
capabilities = init_response.worker_init_response.capabilities
self.assertNotIn("WorkerOpenTelemetryEnabled", capabilities)

@patch.dict(os.environ, {'PYTHON_ENABLE_OPENTELEMETRY': 'true'})
def test_init_request_enable_opentelemetry_enabled_app_setting(
self,
):

init_request = protos.StreamingMessage(
worker_init_request=protos.WorkerInitRequest(
host_version="2.3.4",
function_app_directory=str(FUNCTION_APP_DIRECTORY)
)
)

init_response = self.loop.run_until_complete(
self.dispatcher._handle__worker_init_request(init_request))

self.assertEqual(init_response.worker_init_response.result.status,
protos.StatusResult.Success)

# Verify otel_libs_available is set to True
self.assertTrue(self.dispatcher._otel_libs_available)
# Verify that WorkerOpenTelemetryEnabled capability is set to _TRUE
capabilities = init_response.worker_init_response.capabilities
self.assertIn("WorkerOpenTelemetryEnabled", capabilities)
self.assertEqual(capabilities["WorkerOpenTelemetryEnabled"], "true")

@patch.dict(os.environ, {})
def test_init_request_enable_opentelemetry_default_app_setting(
self,
):

init_request = protos.StreamingMessage(
worker_init_request=protos.WorkerInitRequest(
host_version="2.3.4",
function_app_directory=str(FUNCTION_APP_DIRECTORY)
)
)

init_response = self.loop.run_until_complete(
self.dispatcher._handle__worker_init_request(init_request))

self.assertEqual(init_response.worker_init_response.result.status,
protos.StatusResult.Success)

# Verify otel_libs_available is set to False by default
self.assertFalse(self.dispatcher._otel_libs_available)
# Verify that WorkerOpenTelemetryEnabled capability is not set
capabilities = init_response.worker_init_response.capabilities
self.assertNotIn("WorkerOpenTelemetryEnabled", capabilities)

@patch.dict(os.environ, {'PYTHON_APPLICATIONINSIGHTS_ENABLE_TELEMETRY': 'false'})
def test_init_request_enable_azure_monitor_disabled_app_setting(
self,
):

init_request = protos.StreamingMessage(
worker_init_request=protos.WorkerInitRequest(
host_version="2.3.4",
function_app_directory=str(FUNCTION_APP_DIRECTORY)
)
)

init_response = self.loop.run_until_complete(
self.dispatcher._handle__worker_init_request(init_request))

self.assertEqual(init_response.worker_init_response.result.status,
protos.StatusResult.Success)

# Verify otel_libs_available is set to False by default
self.assertFalse(self.dispatcher._otel_libs_available)
# Verify that WorkerOpenTelemetryEnabled capability is not set
capabilities = init_response.worker_init_response.capabilities
self.assertNotIn("WorkerOpenTelemetryEnabled", capabilities)
Loading