mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-31 22:23:12 +08:00
Remove unreleaseable packages
We are having trouble releaseing opentelemetry-instrumentation-atiohttp-server and opentelemetry-resource-detector-container because PyPi is rejecting them. Removing them from this release to allow the other packages to be released.
This commit is contained in:
@ -1,24 +0,0 @@
|
|||||||
OpenTelemetry aiohttp server Integration
|
|
||||||
========================================
|
|
||||||
|
|
||||||
|pypi|
|
|
||||||
|
|
||||||
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-aiohttp-client.svg
|
|
||||||
:target: https://pypi.org/project/opentelemetry-instrumentation-aiohttp-client/
|
|
||||||
|
|
||||||
This library allows tracing HTTP requests made by the
|
|
||||||
`aiohttp server <https://docs.aiohttp.org/en/stable/server.html>`_ library.
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
pip install opentelemetry-instrumentation-aiohttp-server
|
|
||||||
|
|
||||||
References
|
|
||||||
----------
|
|
||||||
|
|
||||||
* `OpenTelemetry Project <https://opentelemetry.io/>`_
|
|
||||||
* `aiohttp client Tracing <https://docs.aiohttp.org/en/stable/tracing_reference.html>`_
|
|
||||||
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
|
|
@ -1,61 +0,0 @@
|
|||||||
[build-system]
|
|
||||||
requires = ["hatchling"]
|
|
||||||
build-backend = "hatchling.build"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "opentelemetry-instrumentation-aiohttp-server"
|
|
||||||
dynamic = ["version"]
|
|
||||||
description = "Aiohttp server instrumentation for OpenTelemetry"
|
|
||||||
readme = "README.rst"
|
|
||||||
license = "Apache-2.0"
|
|
||||||
requires-python = ">=3.7"
|
|
||||||
authors = [
|
|
||||||
{ name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io"}
|
|
||||||
]
|
|
||||||
classifiers = [
|
|
||||||
"Development Status :: 4 - Beta",
|
|
||||||
"Intended Audience :: Developers",
|
|
||||||
"License :: OSI Approved :: Apache Software License",
|
|
||||||
"Programming Language :: Python",
|
|
||||||
"Programming Language :: Python :: 3",
|
|
||||||
"Programming Language :: Python :: 3.7",
|
|
||||||
"Programming Language :: Python :: 3.8",
|
|
||||||
"Programming Language :: Python :: 3.9",
|
|
||||||
"Programming Language :: Python :: 3.10",
|
|
||||||
"Programming Language :: Python :: 3.11"
|
|
||||||
]
|
|
||||||
dependencies = [
|
|
||||||
"opentelemetry-api ~= 1.12",
|
|
||||||
"opentelemetry-instrumentation == 0.43b0",
|
|
||||||
"opentelemetry-semantic-conventions == 0.43b0",
|
|
||||||
"opentelemetry-util-http == 0.43b0",
|
|
||||||
"wrapt >= 1.0.0, < 2.0.0",
|
|
||||||
]
|
|
||||||
|
|
||||||
[project.optional-dependencies]
|
|
||||||
instruments = [
|
|
||||||
"aiohttp ~= 3.0",
|
|
||||||
]
|
|
||||||
test = [
|
|
||||||
"opentelemetry-instrumentation-aiohttp-server[instruments]",
|
|
||||||
"pytest-asyncio",
|
|
||||||
"pytest-aiohttp",
|
|
||||||
]
|
|
||||||
|
|
||||||
[project.entry-points.opentelemetry_instrumentor]
|
|
||||||
aiohttp-server = "opentelemetry.instrumentation.aiohttp_server:AioHttpServerInstrumentor"
|
|
||||||
|
|
||||||
[project.urls]
|
|
||||||
Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-aiohttp-server"
|
|
||||||
|
|
||||||
[tool.hatch.version]
|
|
||||||
path = "src/opentelemetry/instrumentation/aiohttp_server/version.py"
|
|
||||||
|
|
||||||
[tool.hatch.build.targets.sdist]
|
|
||||||
include = [
|
|
||||||
"/src",
|
|
||||||
"/tests",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.hatch.build.targets.wheel]
|
|
||||||
packages = ["src/opentelemetry"]
|
|
@ -1,267 +0,0 @@
|
|||||||
# Copyright 2020, OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
import urllib
|
|
||||||
from timeit import default_timer
|
|
||||||
from typing import Dict, List, Tuple, Union
|
|
||||||
|
|
||||||
from aiohttp import web
|
|
||||||
from multidict import CIMultiDictProxy
|
|
||||||
|
|
||||||
from opentelemetry import context, metrics, trace
|
|
||||||
from opentelemetry.context import _SUPPRESS_HTTP_INSTRUMENTATION_KEY
|
|
||||||
from opentelemetry.instrumentation.aiohttp_server.package import _instruments
|
|
||||||
from opentelemetry.instrumentation.aiohttp_server.version import __version__
|
|
||||||
from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
|
|
||||||
from opentelemetry.instrumentation.utils import http_status_to_status_code
|
|
||||||
from opentelemetry.propagate import extract
|
|
||||||
from opentelemetry.propagators.textmap import Getter
|
|
||||||
from opentelemetry.semconv.metrics import MetricInstruments
|
|
||||||
from opentelemetry.semconv.trace import SpanAttributes
|
|
||||||
from opentelemetry.trace.status import Status, StatusCode
|
|
||||||
from opentelemetry.util.http import get_excluded_urls, remove_url_credentials
|
|
||||||
|
|
||||||
_duration_attrs = [
|
|
||||||
SpanAttributes.HTTP_METHOD,
|
|
||||||
SpanAttributes.HTTP_HOST,
|
|
||||||
SpanAttributes.HTTP_SCHEME,
|
|
||||||
SpanAttributes.HTTP_STATUS_CODE,
|
|
||||||
SpanAttributes.HTTP_FLAVOR,
|
|
||||||
SpanAttributes.HTTP_SERVER_NAME,
|
|
||||||
SpanAttributes.NET_HOST_NAME,
|
|
||||||
SpanAttributes.NET_HOST_PORT,
|
|
||||||
SpanAttributes.HTTP_ROUTE,
|
|
||||||
]
|
|
||||||
|
|
||||||
_active_requests_count_attrs = [
|
|
||||||
SpanAttributes.HTTP_METHOD,
|
|
||||||
SpanAttributes.HTTP_HOST,
|
|
||||||
SpanAttributes.HTTP_SCHEME,
|
|
||||||
SpanAttributes.HTTP_FLAVOR,
|
|
||||||
SpanAttributes.HTTP_SERVER_NAME,
|
|
||||||
]
|
|
||||||
|
|
||||||
tracer = trace.get_tracer(__name__)
|
|
||||||
meter = metrics.get_meter(__name__, __version__)
|
|
||||||
_excluded_urls = get_excluded_urls("AIOHTTP_SERVER")
|
|
||||||
|
|
||||||
|
|
||||||
def _parse_duration_attrs(req_attrs):
|
|
||||||
duration_attrs = {}
|
|
||||||
for attr_key in _duration_attrs:
|
|
||||||
if req_attrs.get(attr_key) is not None:
|
|
||||||
duration_attrs[attr_key] = req_attrs[attr_key]
|
|
||||||
return duration_attrs
|
|
||||||
|
|
||||||
|
|
||||||
def _parse_active_request_count_attrs(req_attrs):
|
|
||||||
active_requests_count_attrs = {}
|
|
||||||
for attr_key in _active_requests_count_attrs:
|
|
||||||
if req_attrs.get(attr_key) is not None:
|
|
||||||
active_requests_count_attrs[attr_key] = req_attrs[attr_key]
|
|
||||||
return active_requests_count_attrs
|
|
||||||
|
|
||||||
|
|
||||||
def get_default_span_details(request: web.Request) -> Tuple[str, dict]:
|
|
||||||
"""Default implementation for get_default_span_details
|
|
||||||
Args:
|
|
||||||
request: the request object itself.
|
|
||||||
Returns:
|
|
||||||
a tuple of the span name, and any attributes to attach to the span.
|
|
||||||
"""
|
|
||||||
span_name = request.path.strip() or f"HTTP {request.method}"
|
|
||||||
return span_name, {}
|
|
||||||
|
|
||||||
|
|
||||||
def _get_view_func(request: web.Request) -> str:
|
|
||||||
"""Returns the name of the request handler.
|
|
||||||
Args:
|
|
||||||
request: the request object itself.
|
|
||||||
Returns:
|
|
||||||
a string containing the name of the handler function
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
return request.match_info.handler.__name__
|
|
||||||
except AttributeError:
|
|
||||||
return "unknown"
|
|
||||||
|
|
||||||
|
|
||||||
def collect_request_attributes(request: web.Request) -> Dict:
|
|
||||||
"""Collects HTTP request attributes from the ASGI scope and returns a
|
|
||||||
dictionary to be used as span creation attributes."""
|
|
||||||
|
|
||||||
server_host, port, http_url = (
|
|
||||||
request.url.host,
|
|
||||||
request.url.port,
|
|
||||||
str(request.url),
|
|
||||||
)
|
|
||||||
query_string = request.query_string
|
|
||||||
if query_string and http_url:
|
|
||||||
if isinstance(query_string, bytes):
|
|
||||||
query_string = query_string.decode("utf8")
|
|
||||||
http_url += "?" + urllib.parse.unquote(query_string)
|
|
||||||
|
|
||||||
result = {
|
|
||||||
SpanAttributes.HTTP_SCHEME: request.scheme,
|
|
||||||
SpanAttributes.HTTP_HOST: server_host,
|
|
||||||
SpanAttributes.NET_HOST_PORT: port,
|
|
||||||
SpanAttributes.HTTP_ROUTE: _get_view_func(request),
|
|
||||||
SpanAttributes.HTTP_FLAVOR: f"{request.version.major}.{request.version.minor}",
|
|
||||||
SpanAttributes.HTTP_TARGET: request.path,
|
|
||||||
SpanAttributes.HTTP_URL: remove_url_credentials(http_url),
|
|
||||||
}
|
|
||||||
|
|
||||||
http_method = request.method
|
|
||||||
if http_method:
|
|
||||||
result[SpanAttributes.HTTP_METHOD] = http_method
|
|
||||||
|
|
||||||
http_host_value_list = (
|
|
||||||
[request.host] if not isinstance(request.host, list) else request.host
|
|
||||||
)
|
|
||||||
if http_host_value_list:
|
|
||||||
result[SpanAttributes.HTTP_SERVER_NAME] = ",".join(
|
|
||||||
http_host_value_list
|
|
||||||
)
|
|
||||||
http_user_agent = request.headers.get("user-agent")
|
|
||||||
if http_user_agent:
|
|
||||||
result[SpanAttributes.HTTP_USER_AGENT] = http_user_agent
|
|
||||||
|
|
||||||
# remove None values
|
|
||||||
result = {k: v for k, v in result.items() if v is not None}
|
|
||||||
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def set_status_code(span, status_code: int) -> None:
|
|
||||||
"""Adds HTTP response attributes to span using the status_code argument."""
|
|
||||||
|
|
||||||
try:
|
|
||||||
status_code = int(status_code)
|
|
||||||
except ValueError:
|
|
||||||
span.set_status(
|
|
||||||
Status(
|
|
||||||
StatusCode.ERROR,
|
|
||||||
"Non-integer HTTP status: " + repr(status_code),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
span.set_attribute(SpanAttributes.HTTP_STATUS_CODE, status_code)
|
|
||||||
span.set_status(
|
|
||||||
Status(http_status_to_status_code(status_code, server_span=True))
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class AiohttpGetter(Getter):
|
|
||||||
"""Extract current trace from headers"""
|
|
||||||
|
|
||||||
def get(self, carrier, key: str) -> Union[List, None]:
|
|
||||||
"""Getter implementation to retrieve an HTTP header value from the ASGI
|
|
||||||
scope.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
carrier: ASGI scope object
|
|
||||||
key: header name in scope
|
|
||||||
Returns:
|
|
||||||
A list of all header values matching the key, or None if the key
|
|
||||||
does not match any header.
|
|
||||||
"""
|
|
||||||
headers: CIMultiDictProxy = carrier.headers
|
|
||||||
if not headers:
|
|
||||||
return None
|
|
||||||
return headers.getall(key, None)
|
|
||||||
|
|
||||||
def keys(self, carrier: Dict) -> List:
|
|
||||||
return list(carrier.keys())
|
|
||||||
|
|
||||||
|
|
||||||
getter = AiohttpGetter()
|
|
||||||
|
|
||||||
|
|
||||||
@web.middleware
|
|
||||||
async def middleware(request, handler):
|
|
||||||
"""Middleware for aiohttp implementing tracing logic"""
|
|
||||||
if (
|
|
||||||
context.get_value("suppress_instrumentation")
|
|
||||||
or context.get_value(_SUPPRESS_HTTP_INSTRUMENTATION_KEY)
|
|
||||||
or _excluded_urls.url_disabled(request.url.path)
|
|
||||||
):
|
|
||||||
return await handler(request)
|
|
||||||
|
|
||||||
span_name, additional_attributes = get_default_span_details(request)
|
|
||||||
|
|
||||||
req_attrs = collect_request_attributes(request)
|
|
||||||
duration_attrs = _parse_duration_attrs(req_attrs)
|
|
||||||
active_requests_count_attrs = _parse_active_request_count_attrs(req_attrs)
|
|
||||||
|
|
||||||
duration_histogram = meter.create_histogram(
|
|
||||||
name=MetricInstruments.HTTP_SERVER_DURATION,
|
|
||||||
unit="ms",
|
|
||||||
description="measures the duration of the inbound HTTP request",
|
|
||||||
)
|
|
||||||
|
|
||||||
active_requests_counter = meter.create_up_down_counter(
|
|
||||||
name=MetricInstruments.HTTP_SERVER_ACTIVE_REQUESTS,
|
|
||||||
unit="requests",
|
|
||||||
description="measures the number of concurrent HTTP requests those are currently in flight",
|
|
||||||
)
|
|
||||||
|
|
||||||
with tracer.start_as_current_span(
|
|
||||||
span_name,
|
|
||||||
context=extract(request, getter=getter),
|
|
||||||
kind=trace.SpanKind.SERVER,
|
|
||||||
) as span:
|
|
||||||
attributes = collect_request_attributes(request)
|
|
||||||
attributes.update(additional_attributes)
|
|
||||||
span.set_attributes(attributes)
|
|
||||||
start = default_timer()
|
|
||||||
active_requests_counter.add(1, active_requests_count_attrs)
|
|
||||||
try:
|
|
||||||
resp = await handler(request)
|
|
||||||
set_status_code(span, resp.status)
|
|
||||||
except web.HTTPException as ex:
|
|
||||||
set_status_code(span, ex.status_code)
|
|
||||||
raise
|
|
||||||
finally:
|
|
||||||
duration = max((default_timer() - start) * 1000, 0)
|
|
||||||
duration_histogram.record(duration, duration_attrs)
|
|
||||||
active_requests_counter.add(-1, active_requests_count_attrs)
|
|
||||||
return resp
|
|
||||||
|
|
||||||
|
|
||||||
class _InstrumentedApplication(web.Application):
|
|
||||||
"""Insert tracing middleware"""
|
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
middlewares = kwargs.pop("middlewares", [])
|
|
||||||
middlewares.insert(0, middleware)
|
|
||||||
kwargs["middlewares"] = middlewares
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
class AioHttpServerInstrumentor(BaseInstrumentor):
|
|
||||||
# pylint: disable=protected-access,attribute-defined-outside-init
|
|
||||||
"""An instrumentor for aiohttp.web.Application
|
|
||||||
|
|
||||||
See `BaseInstrumentor`
|
|
||||||
"""
|
|
||||||
|
|
||||||
def _instrument(self, **kwargs):
|
|
||||||
self._original_app = web.Application
|
|
||||||
setattr(web, "Application", _InstrumentedApplication)
|
|
||||||
|
|
||||||
def _uninstrument(self, **kwargs):
|
|
||||||
setattr(web, "Application", self._original_app)
|
|
||||||
|
|
||||||
def instrumentation_dependencies(self):
|
|
||||||
return _instruments
|
|
@ -1,16 +0,0 @@
|
|||||||
# Copyright The OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
|
|
||||||
_instruments = ("aiohttp ~= 3.0",)
|
|
@ -1,15 +0,0 @@
|
|||||||
# Copyright The OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
__version__ = "0.43b0"
|
|
@ -1,130 +0,0 @@
|
|||||||
# Copyright 2020, OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
from enum import Enum
|
|
||||||
from http import HTTPStatus
|
|
||||||
|
|
||||||
import aiohttp
|
|
||||||
import pytest
|
|
||||||
import pytest_asyncio
|
|
||||||
|
|
||||||
from opentelemetry import trace as trace_api
|
|
||||||
from opentelemetry.instrumentation.aiohttp_server import (
|
|
||||||
AioHttpServerInstrumentor,
|
|
||||||
)
|
|
||||||
from opentelemetry.semconv.trace import SpanAttributes
|
|
||||||
from opentelemetry.test.globals_test import reset_trace_globals
|
|
||||||
from opentelemetry.test.test_base import TestBase
|
|
||||||
from opentelemetry.util._importlib_metadata import entry_points
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPMethod(Enum):
|
|
||||||
"""HTTP methods and descriptions"""
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
return f"{self.value}"
|
|
||||||
|
|
||||||
CONNECT = "CONNECT"
|
|
||||||
DELETE = "DELETE"
|
|
||||||
GET = "GET"
|
|
||||||
HEAD = "HEAD"
|
|
||||||
OPTIONS = "OPTIONS"
|
|
||||||
PATCH = "PATCH"
|
|
||||||
POST = "POST"
|
|
||||||
PUT = "PUT"
|
|
||||||
TRACE = "TRACE"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(name="tracer", scope="session")
|
|
||||||
def fixture_tracer():
|
|
||||||
test_base = TestBase()
|
|
||||||
|
|
||||||
tracer_provider, memory_exporter = test_base.create_tracer_provider()
|
|
||||||
|
|
||||||
reset_trace_globals()
|
|
||||||
trace_api.set_tracer_provider(tracer_provider)
|
|
||||||
|
|
||||||
yield tracer_provider, memory_exporter
|
|
||||||
|
|
||||||
reset_trace_globals()
|
|
||||||
|
|
||||||
|
|
||||||
async def default_handler(request, status=200):
|
|
||||||
return aiohttp.web.Response(status=status)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest_asyncio.fixture(name="server_fixture")
|
|
||||||
async def fixture_server_fixture(tracer, aiohttp_server):
|
|
||||||
_, memory_exporter = tracer
|
|
||||||
|
|
||||||
AioHttpServerInstrumentor().instrument()
|
|
||||||
|
|
||||||
app = aiohttp.web.Application()
|
|
||||||
app.add_routes([aiohttp.web.get("/test-path", default_handler)])
|
|
||||||
|
|
||||||
server = await aiohttp_server(app)
|
|
||||||
yield server, app
|
|
||||||
|
|
||||||
memory_exporter.clear()
|
|
||||||
|
|
||||||
AioHttpServerInstrumentor().uninstrument()
|
|
||||||
|
|
||||||
|
|
||||||
def test_checking_instrumentor_pkg_installed():
|
|
||||||
|
|
||||||
(instrumentor_entrypoint,) = entry_points(
|
|
||||||
group="opentelemetry_instrumentor", name="aiohttp-server"
|
|
||||||
)
|
|
||||||
instrumentor = instrumentor_entrypoint.load()()
|
|
||||||
assert isinstance(instrumentor, AioHttpServerInstrumentor)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"url, expected_method, expected_status_code",
|
|
||||||
[
|
|
||||||
("/test-path", HTTPMethod.GET, HTTPStatus.OK),
|
|
||||||
("/not-found", HTTPMethod.GET, HTTPStatus.NOT_FOUND),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
async def test_status_code_instrumentation(
|
|
||||||
tracer,
|
|
||||||
server_fixture,
|
|
||||||
aiohttp_client,
|
|
||||||
url,
|
|
||||||
expected_method,
|
|
||||||
expected_status_code,
|
|
||||||
):
|
|
||||||
_, memory_exporter = tracer
|
|
||||||
server, _ = server_fixture
|
|
||||||
|
|
||||||
assert len(memory_exporter.get_finished_spans()) == 0
|
|
||||||
|
|
||||||
client = await aiohttp_client(server)
|
|
||||||
await client.get(url)
|
|
||||||
|
|
||||||
assert len(memory_exporter.get_finished_spans()) == 1
|
|
||||||
|
|
||||||
[span] = memory_exporter.get_finished_spans()
|
|
||||||
|
|
||||||
assert expected_method.value == span.attributes[SpanAttributes.HTTP_METHOD]
|
|
||||||
assert (
|
|
||||||
expected_status_code
|
|
||||||
== span.attributes[SpanAttributes.HTTP_STATUS_CODE]
|
|
||||||
)
|
|
||||||
|
|
||||||
assert (
|
|
||||||
f"http://{server.host}:{server.port}{url}"
|
|
||||||
== span.attributes[SpanAttributes.HTTP_URL]
|
|
||||||
)
|
|
@ -1,201 +0,0 @@
|
|||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright The OpenTelemetry Authors
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
@ -1,9 +0,0 @@
|
|||||||
graft src
|
|
||||||
graft tests
|
|
||||||
global-exclude *.pyc
|
|
||||||
global-exclude *.pyo
|
|
||||||
global-exclude __pycache__/*
|
|
||||||
include CHANGELOG.md
|
|
||||||
include MANIFEST.in
|
|
||||||
include README.rst
|
|
||||||
include LICENSE
|
|
@ -1,46 +0,0 @@
|
|||||||
OpenTelemetry Resource detectors for containers
|
|
||||||
==========================================================
|
|
||||||
|
|
||||||
|pypi|
|
|
||||||
|
|
||||||
.. |pypi| image:: TODO
|
|
||||||
:target: TODO
|
|
||||||
|
|
||||||
|
|
||||||
This library provides custom resource detector for container platforms
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
pip install opentelemetry-resource-detector-container
|
|
||||||
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
Usage example for `opentelemetry-resource-detector-container`
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
from opentelemetry import trace
|
|
||||||
from opentelemetry.sdk.trace import TracerProvider
|
|
||||||
from opentelemetry.resource.detector.container import (
|
|
||||||
ContainerResourceDetector,
|
|
||||||
)
|
|
||||||
from opentelemetry.sdk.resources import get_aggregated_resources
|
|
||||||
|
|
||||||
|
|
||||||
trace.set_tracer_provider(
|
|
||||||
TracerProvider(
|
|
||||||
resource=get_aggregated_resources(
|
|
||||||
[
|
|
||||||
ContainerResourceDetector(),
|
|
||||||
]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
References
|
|
||||||
----------
|
|
||||||
|
|
||||||
* `OpenTelemetry Project <https://opentelemetry.io/>`_
|
|
@ -1,50 +0,0 @@
|
|||||||
[build-system]
|
|
||||||
requires = ["hatchling"]
|
|
||||||
build-backend = "hatchling.build"
|
|
||||||
|
|
||||||
[project]
|
|
||||||
name = "opentelemetry-resource-detector-container"
|
|
||||||
dynamic = ["version"]
|
|
||||||
description = "Container Resource Detector for OpenTelemetry"
|
|
||||||
readme = "README.rst"
|
|
||||||
license = "Apache-2.0"
|
|
||||||
requires-python = ">=3.7"
|
|
||||||
authors = [
|
|
||||||
{ name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" },
|
|
||||||
]
|
|
||||||
classifiers = [
|
|
||||||
"Development Status :: 5 - Production/Stable",
|
|
||||||
"Intended Audience :: Developers",
|
|
||||||
"License :: OSI Approved :: Apache Software License",
|
|
||||||
"Programming Language :: Python",
|
|
||||||
"Programming Language :: Python :: 3",
|
|
||||||
"Programming Language :: Python :: 3.7",
|
|
||||||
"Programming Language :: Python :: 3.8",
|
|
||||||
"Programming Language :: Python :: 3.9",
|
|
||||||
"Programming Language :: Python :: 3.10",
|
|
||||||
"Programming Language :: Python :: 3.11",
|
|
||||||
]
|
|
||||||
dependencies = [
|
|
||||||
"opentelemetry-sdk ~= 1.12",
|
|
||||||
]
|
|
||||||
|
|
||||||
[project.optional-dependencies]
|
|
||||||
test = []
|
|
||||||
|
|
||||||
[project.entry-points.opentelemetry_resource_detector]
|
|
||||||
container = "opentelemetry.resource.detector.container:ContainerResourceDetector"
|
|
||||||
|
|
||||||
[project.urls]
|
|
||||||
Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/resource/opentelemetry-resource-detector-container"
|
|
||||||
|
|
||||||
[tool.hatch.version]
|
|
||||||
path = "src/opentelemetry/resource/detector/container/version.py"
|
|
||||||
|
|
||||||
[tool.hatch.build.targets.sdist]
|
|
||||||
include = [
|
|
||||||
"/src",
|
|
||||||
"/tests",
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.hatch.build.targets.wheel]
|
|
||||||
packages = ["src/opentelemetry"]
|
|
@ -1,95 +0,0 @@
|
|||||||
# Copyright The OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
from logging import getLogger
|
|
||||||
|
|
||||||
from opentelemetry.sdk.resources import Resource, ResourceDetector
|
|
||||||
from opentelemetry.semconv.resource import ResourceAttributes
|
|
||||||
|
|
||||||
logger = getLogger(__name__)
|
|
||||||
_DEFAULT_CGROUP_V1_PATH = "/proc/self/cgroup"
|
|
||||||
_DEFAULT_CGROUP_V2_PATH = "/proc/self/mountinfo"
|
|
||||||
_CONTAINER_ID_LENGTH = 64
|
|
||||||
|
|
||||||
|
|
||||||
def _get_container_id_v1():
|
|
||||||
container_id = None
|
|
||||||
try:
|
|
||||||
with open(
|
|
||||||
_DEFAULT_CGROUP_V1_PATH, encoding="utf8"
|
|
||||||
) as container_info_file:
|
|
||||||
for raw_line in container_info_file.readlines():
|
|
||||||
line = raw_line.strip()
|
|
||||||
if len(line) > _CONTAINER_ID_LENGTH:
|
|
||||||
container_id = line[-_CONTAINER_ID_LENGTH:]
|
|
||||||
break
|
|
||||||
except FileNotFoundError as exception:
|
|
||||||
logger.warning("Failed to get container id. Exception: %s", exception)
|
|
||||||
return container_id
|
|
||||||
|
|
||||||
|
|
||||||
def _get_container_id_v2():
|
|
||||||
container_id = None
|
|
||||||
try:
|
|
||||||
with open(
|
|
||||||
_DEFAULT_CGROUP_V2_PATH, encoding="utf8"
|
|
||||||
) as container_info_file:
|
|
||||||
for raw_line in container_info_file.readlines():
|
|
||||||
line = raw_line.strip()
|
|
||||||
if any(
|
|
||||||
key_word in line for key_word in ["containers", "hostname"]
|
|
||||||
):
|
|
||||||
container_id_list = [
|
|
||||||
id_
|
|
||||||
for id_ in line.split("/")
|
|
||||||
if len(id_) == _CONTAINER_ID_LENGTH
|
|
||||||
]
|
|
||||||
if len(container_id_list) > 0:
|
|
||||||
container_id = container_id_list[0]
|
|
||||||
break
|
|
||||||
|
|
||||||
except FileNotFoundError as exception:
|
|
||||||
logger.warning("Failed to get container id. Exception: %s", exception)
|
|
||||||
return container_id
|
|
||||||
|
|
||||||
|
|
||||||
def _get_container_id():
|
|
||||||
return _get_container_id_v1() or _get_container_id_v2()
|
|
||||||
|
|
||||||
|
|
||||||
class ContainerResourceDetector(ResourceDetector):
|
|
||||||
"""Detects container.id only available when app is running inside the
|
|
||||||
docker container and return it in a Resource
|
|
||||||
"""
|
|
||||||
|
|
||||||
def detect(self) -> "Resource":
|
|
||||||
try:
|
|
||||||
container_id = _get_container_id()
|
|
||||||
resource = Resource.get_empty()
|
|
||||||
if container_id:
|
|
||||||
resource = resource.merge(
|
|
||||||
Resource({ResourceAttributes.CONTAINER_ID: container_id})
|
|
||||||
)
|
|
||||||
return resource
|
|
||||||
|
|
||||||
# pylint: disable=broad-except
|
|
||||||
except Exception as exception:
|
|
||||||
logger.warning(
|
|
||||||
"%s Resource Detection failed silently: %s",
|
|
||||||
self.__class__.__name__,
|
|
||||||
exception,
|
|
||||||
)
|
|
||||||
if self.raise_on_error:
|
|
||||||
raise exception
|
|
||||||
return Resource.get_empty()
|
|
@ -1,15 +0,0 @@
|
|||||||
# Copyright The OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
__version__ = "0.43b0"
|
|
@ -1,146 +0,0 @@
|
|||||||
# Copyright The OpenTelemetry Authors
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
|
|
||||||
from unittest.mock import mock_open, patch
|
|
||||||
|
|
||||||
from opentelemetry import trace as trace_api
|
|
||||||
from opentelemetry.resource.detector.container import ContainerResourceDetector
|
|
||||||
from opentelemetry.sdk.resources import get_aggregated_resources
|
|
||||||
from opentelemetry.semconv.resource import ResourceAttributes
|
|
||||||
from opentelemetry.test.test_base import TestBase
|
|
||||||
|
|
||||||
MockContainerResourceAttributes = {
|
|
||||||
ResourceAttributes.CONTAINER_ID: "7be92808767a667f35c8505cbf40d14e931ef6db5b0210329cf193b15ba9d605",
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class ContainerResourceDetectorTest(TestBase):
|
|
||||||
@patch(
|
|
||||||
"builtins.open",
|
|
||||||
new_callable=mock_open,
|
|
||||||
read_data=f"""14:name=systemd:/docker/{MockContainerResourceAttributes[ResourceAttributes.CONTAINER_ID]}
|
|
||||||
13:rdma:/
|
|
||||||
12:pids:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
11:hugetlb:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
10:net_prio:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
9:perf_event:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
8:net_cls:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
7:freezer:/docker/
|
|
||||||
6:devices:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
5:memory:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
4:blkio:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
3:cpuacct:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
2:cpu:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
1:cpuset:/docker/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
def test_container_id_detect_from_cgroup_file(self, mock_cgroup_file):
|
|
||||||
actual = ContainerResourceDetector().detect()
|
|
||||||
self.assertDictEqual(
|
|
||||||
actual.attributes.copy(), MockContainerResourceAttributes
|
|
||||||
)
|
|
||||||
|
|
||||||
@patch(
|
|
||||||
"opentelemetry.resource.detector.container._get_container_id_v1",
|
|
||||||
return_value=None,
|
|
||||||
)
|
|
||||||
@patch(
|
|
||||||
"builtins.open",
|
|
||||||
new_callable=mock_open,
|
|
||||||
read_data=f"""
|
|
||||||
608 607 0:183 / /proc rw,nosuid,nodev,noexec,relatime - proc proc rw
|
|
||||||
609 607 0:184 / /dev rw,nosuid - tmpfs tmpfs rw,size=65536k,mode=755
|
|
||||||
610 609 0:185 / /dev/pts rw,nosuid,noexec,relatime - devpts devpts rw,gid=5,mode=620,ptmxmode=666
|
|
||||||
611 607 0:186 / /sys ro,nosuid,nodev,noexec,relatime - sysfs sysfs ro
|
|
||||||
612 611 0:29 / /sys/fs/cgroup ro,nosuid,nodev,noexec,relatime - cgroup2 cgroup rw
|
|
||||||
613 609 0:182 / /dev/mqueue rw,nosuid,nodev,noexec,relatime - mqueue mqueue rw
|
|
||||||
614 609 0:187 / /dev/shm rw,nosuid,nodev,noexec,relatime - tmpfs shm rw,size=65536k
|
|
||||||
615 607 254:1 /docker/containers/{MockContainerResourceAttributes[ResourceAttributes.CONTAINER_ID]}/resolv.conf /etc/resolv.conf rw,relatime - ext4 /dev/vda1 rw
|
|
||||||
616 607 254:1 /docker/containers/{MockContainerResourceAttributes[ResourceAttributes.CONTAINER_ID]}/hostname /etc/hostname rw,relatime - ext4 /dev/vda1 rw
|
|
||||||
617 607 254:1 /docker/containers/bogusContainerIdThatShouldNotBeOneSetBecauseTheFirstOneWasPicked/hosts /etc/hosts rw,relatime - ext4 /dev/vda1 rw
|
|
||||||
618 607 0:131 /Users/sankmeht/development/otel/opentelemetry-python /development/otel/opentelemetry-python rw,nosuid,nodev,relatime - fuse.grpcfuse grpcfuse rw,user_id=0,group_id=0,allow_other,max_read=1048576
|
|
||||||
619 607 0:131 /Users/sankmeht/development/otel/opentelemetry-python-contrib /development/otel/opentelemetry-python-contrib rw,nosuid,nodev,relatime - fuse.grpcfuse grpcfuse rw,user_id=0,group_id=0,allow_other,max_read=1048576
|
|
||||||
519 609 0:185 /0 /dev/console rw,nosuid,noexec,relatime - devpts devpts rw,gid=5,mode=620,ptmxmode=666
|
|
||||||
520 608 0:183 /bus /proc/bus ro,nosuid,nodev,noexec,relatime - proc proc rw
|
|
||||||
521 608 0:183 /fs /proc/fs ro,nosuid,nodev,noexec,relatime - proc proc rw
|
|
||||||
522 608 0:183 /irq /proc/irq ro,nosuid,nodev,noexec,relatime - proc proc rw
|
|
||||||
523 608 0:183 /sys /proc/sys ro,nosuid,nodev,noexec,relatime - proc proc rw
|
|
||||||
524 608 0:183 /sysrq-trigger /proc/sysrq-trigger ro,nosuid,nodev,noexec,relatime - proc proc rw
|
|
||||||
525 608 0:212 / /proc/acpi ro,relatime - tmpfs tmpfs ro
|
|
||||||
526 608 0:184 /null /proc/kcore rw,nosuid - tmpfs tmpfs rw,size=65536k,mode=755
|
|
||||||
527 608 0:184 /null /proc/keys rw,nosuid - tmpfs tmpfs rw,size=65536k,mode=755
|
|
||||||
528 608 0:184 /null /proc/timer_list rw,nosuid - tmpfs tmpfs rw,size=65536k,mode=755
|
|
||||||
529 611 0:213 / /sys/firmware ro,relatime - tmpfs tmpfs ro
|
|
||||||
""",
|
|
||||||
)
|
|
||||||
def test_container_id_detect_from_mountinfo_file(
|
|
||||||
self, mock_get_container_id_v1, mock_cgroup_file
|
|
||||||
):
|
|
||||||
actual = ContainerResourceDetector().detect()
|
|
||||||
self.assertDictEqual(
|
|
||||||
actual.attributes.copy(), MockContainerResourceAttributes
|
|
||||||
)
|
|
||||||
|
|
||||||
@patch(
|
|
||||||
"opentelemetry.resource.detector.container._get_container_id",
|
|
||||||
return_value=MockContainerResourceAttributes[
|
|
||||||
ResourceAttributes.CONTAINER_ID
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_container_id_as_span_attribute(self, mock_cgroup_file):
|
|
||||||
tracer_provider, exporter = self.create_tracer_provider(
|
|
||||||
resource=get_aggregated_resources([ContainerResourceDetector()])
|
|
||||||
)
|
|
||||||
tracer = tracer_provider.get_tracer(__name__)
|
|
||||||
|
|
||||||
with tracer.start_as_current_span(
|
|
||||||
"test", kind=trace_api.SpanKind.SERVER
|
|
||||||
) as _:
|
|
||||||
pass
|
|
||||||
|
|
||||||
span_list = exporter.get_finished_spans()
|
|
||||||
self.assertEqual(
|
|
||||||
span_list[0].resource.attributes["container.id"],
|
|
||||||
MockContainerResourceAttributes[ResourceAttributes.CONTAINER_ID],
|
|
||||||
)
|
|
||||||
|
|
||||||
@patch(
|
|
||||||
"opentelemetry.resource.detector.container._get_container_id",
|
|
||||||
return_value=MockContainerResourceAttributes[
|
|
||||||
ResourceAttributes.CONTAINER_ID
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_container_id_detect_from_cgroup(self, mock_get_container_id):
|
|
||||||
actual = ContainerResourceDetector().detect()
|
|
||||||
self.assertDictEqual(
|
|
||||||
actual.attributes.copy(), MockContainerResourceAttributes
|
|
||||||
)
|
|
||||||
|
|
||||||
@patch(
|
|
||||||
"opentelemetry.resource.detector.container._get_container_id_v1",
|
|
||||||
return_value=None,
|
|
||||||
)
|
|
||||||
@patch(
|
|
||||||
"opentelemetry.resource.detector.container._get_container_id_v2",
|
|
||||||
return_value=MockContainerResourceAttributes[
|
|
||||||
ResourceAttributes.CONTAINER_ID
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_container_id_detect_from_mount_info(
|
|
||||||
self, mock_get_container_id_v1, mock_get_container_id_v2
|
|
||||||
):
|
|
||||||
actual = ContainerResourceDetector().detect()
|
|
||||||
self.assertDictEqual(
|
|
||||||
actual.attributes.copy(), MockContainerResourceAttributes
|
|
||||||
)
|
|
Reference in New Issue
Block a user