Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions datadog_checks_base/changelog.d/23487.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add `get_agent_embedded_path` helper to resolve paths under the agent's embedded directory regardless of install location.
22 changes: 22 additions & 0 deletions datadog_checks_base/datadog_checks/base/utils/agent/common.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# (C) Datadog, Inc. 2019-present
# All rights reserved
# Licensed under a 3-clause BSD style license (see LICENSE)
import os

try:
import datadog_agent
except ImportError:
from datadog_checks.base.stubs import datadog_agent

METRIC_NAMESPACE_METRICS = 'datadog.agent.metrics'
METRIC_NAMESPACE_PROFILE = 'datadog.agent.profile'


def get_agent_embedded_path(*parts: str) -> str | None:
"""Resolve a path under the agent's `embedded` directory from the agent's `run_path` config.

Returns ``None`` when ``run_path`` is unset so callers can decide whether the
miss is fatal or merely skips a fallback. Works for both the standard install
(``/opt/datadog-agent/run``) and Remote-Management installs
(``/opt/datadog-packages/datadog-agent/<version>/run``).
"""
run_path = datadog_agent.get_config('run_path')
if not run_path:
return None
install_path = run_path[:-4] if run_path.endswith('/run') else run_path
return os.path.join(install_path, 'embedded', *parts)
49 changes: 49 additions & 0 deletions datadog_checks_base/tests/base/utils/test_agent_common.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# (C) Datadog, Inc. 2026-present
# All rights reserved
# Licensed under a 3-clause BSD style license (see LICENSE)
import mock

from datadog_checks.base.utils.agent.common import get_agent_embedded_path


class TestGetAgentEmbeddedPath:
def test_standard_install(self):
with mock.patch(
'datadog_checks.base.utils.agent.common.datadog_agent.get_config',
return_value='/opt/datadog-agent/run',
):
assert get_agent_embedded_path('sbin', 'gstatus') == '/opt/datadog-agent/embedded/sbin/gstatus'

def test_remote_management_install(self):
with mock.patch(
'datadog_checks.base.utils.agent.common.datadog_agent.get_config',
return_value='/opt/datadog-packages/datadog-agent/7.79.0/run',
):
assert (
get_agent_embedded_path('sbin', 'gstatus')
== '/opt/datadog-packages/datadog-agent/7.79.0/embedded/sbin/gstatus'
)

def test_missing_run_path_returns_none(self):
with mock.patch(
'datadog_checks.base.utils.agent.common.datadog_agent.get_config',
return_value='',
):
assert get_agent_embedded_path('sbin', 'gstatus') is None

def test_run_path_without_trailing_run(self):
with mock.patch(
'datadog_checks.base.utils.agent.common.datadog_agent.get_config',
return_value='/custom/agent/dir',
):
assert (
get_agent_embedded_path('ssl', 'certs', 'cacert.pem')
== '/custom/agent/dir/embedded/ssl/certs/cacert.pem'
)

def test_no_parts_returns_embedded_dir(self):
with mock.patch(
'datadog_checks.base.utils.agent.common.datadog_agent.get_config',
return_value='/opt/datadog-agent/run',
):
assert get_agent_embedded_path() == '/opt/datadog-agent/embedded'
Loading