mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-29 05:04:05 +08:00
Rename remaining framework packages from "ext" to "instrumentation" (#969)
This commit is contained in:
Leighton Chen
@ -0,0 +1,309 @@
|
||||
# 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.
|
||||
|
||||
import os
|
||||
import threading
|
||||
from ast import literal_eval
|
||||
from unittest import mock
|
||||
|
||||
import elasticsearch
|
||||
import elasticsearch.exceptions
|
||||
from elasticsearch import Elasticsearch
|
||||
from elasticsearch_dsl import Search
|
||||
|
||||
import opentelemetry.instrumentation.elasticsearch
|
||||
from opentelemetry.instrumentation.elasticsearch import (
|
||||
ElasticsearchInstrumentor,
|
||||
)
|
||||
from opentelemetry.test.test_base import TestBase
|
||||
from opentelemetry.trace.status import StatusCanonicalCode
|
||||
|
||||
major_version = elasticsearch.VERSION[0]
|
||||
|
||||
if major_version == 7:
|
||||
from . import helpers_es7 as helpers # pylint: disable=no-name-in-module
|
||||
elif major_version == 6:
|
||||
from . import helpers_es6 as helpers # pylint: disable=no-name-in-module
|
||||
elif major_version == 5:
|
||||
from . import helpers_es5 as helpers # pylint: disable=no-name-in-module
|
||||
else:
|
||||
from . import helpers_es2 as helpers # pylint: disable=no-name-in-module
|
||||
|
||||
|
||||
Article = helpers.Article
|
||||
|
||||
|
||||
@mock.patch(
|
||||
"elasticsearch.connection.http_urllib3.Urllib3HttpConnection.perform_request"
|
||||
)
|
||||
class TestElasticsearchIntegration(TestBase):
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
self.tracer = self.tracer_provider.get_tracer(__name__)
|
||||
ElasticsearchInstrumentor().instrument()
|
||||
|
||||
def tearDown(self):
|
||||
super().tearDown()
|
||||
with self.disable_logging():
|
||||
ElasticsearchInstrumentor().uninstrument()
|
||||
|
||||
def get_ordered_finished_spans(self):
|
||||
return sorted(
|
||||
self.memory_exporter.get_finished_spans(),
|
||||
key=lambda s: s.start_time,
|
||||
)
|
||||
|
||||
def test_instrumentor(self, request_mock):
|
||||
request_mock.return_value = (1, {}, {})
|
||||
|
||||
es = Elasticsearch()
|
||||
es.index(index="sw", doc_type="people", id=1, body={"name": "adam"})
|
||||
|
||||
spans_list = self.get_ordered_finished_spans()
|
||||
self.assertEqual(len(spans_list), 1)
|
||||
span = spans_list[0]
|
||||
|
||||
# Check version and name in span's instrumentation info
|
||||
# self.check_span_instrumentation_info(span, opentelemetry.instrumentation.elasticsearch)
|
||||
self.check_span_instrumentation_info(
|
||||
span, opentelemetry.instrumentation.elasticsearch
|
||||
)
|
||||
|
||||
# check that no spans are generated after uninstrument
|
||||
ElasticsearchInstrumentor().uninstrument()
|
||||
|
||||
es.index(index="sw", doc_type="people", id=1, body={"name": "adam"})
|
||||
|
||||
spans_list = self.get_ordered_finished_spans()
|
||||
self.assertEqual(len(spans_list), 1)
|
||||
|
||||
def test_prefix_arg(self, request_mock):
|
||||
prefix = "prefix-from-env"
|
||||
ElasticsearchInstrumentor().uninstrument()
|
||||
ElasticsearchInstrumentor(span_name_prefix=prefix).instrument()
|
||||
request_mock.return_value = (1, {}, {})
|
||||
self._test_prefix(prefix)
|
||||
|
||||
def test_prefix_env(self, request_mock):
|
||||
prefix = "prefix-from-args"
|
||||
env_var = "OTEL_PYTHON_ELASTICSEARCH_NAME_PREFIX"
|
||||
os.environ[env_var] = prefix
|
||||
ElasticsearchInstrumentor().uninstrument()
|
||||
ElasticsearchInstrumentor().instrument()
|
||||
request_mock.return_value = (1, {}, {})
|
||||
del os.environ[env_var]
|
||||
self._test_prefix(prefix)
|
||||
|
||||
def _test_prefix(self, prefix):
|
||||
es = Elasticsearch()
|
||||
es.index(index="sw", doc_type="people", id=1, body={"name": "adam"})
|
||||
|
||||
spans_list = self.get_ordered_finished_spans()
|
||||
self.assertEqual(len(spans_list), 1)
|
||||
span = spans_list[0]
|
||||
self.assertTrue(span.name.startswith(prefix))
|
||||
|
||||
def test_result_values(self, request_mock):
|
||||
request_mock.return_value = (
|
||||
1,
|
||||
{},
|
||||
'{"found": false, "timed_out": true, "took": 7}',
|
||||
)
|
||||
es = Elasticsearch()
|
||||
es.get(index="test-index", doc_type="tweet", id=1)
|
||||
|
||||
spans = self.get_ordered_finished_spans()
|
||||
|
||||
self.assertEqual(1, len(spans))
|
||||
self.assertEqual("False", spans[0].attributes["elasticsearch.found"])
|
||||
self.assertEqual(
|
||||
"True", spans[0].attributes["elasticsearch.timed_out"]
|
||||
)
|
||||
self.assertEqual("7", spans[0].attributes["elasticsearch.took"])
|
||||
|
||||
def test_trace_error_unknown(self, request_mock):
|
||||
exc = RuntimeError("custom error")
|
||||
request_mock.side_effect = exc
|
||||
self._test_trace_error(StatusCanonicalCode.UNKNOWN, exc)
|
||||
|
||||
def test_trace_error_not_found(self, request_mock):
|
||||
msg = "record not found"
|
||||
exc = elasticsearch.exceptions.NotFoundError(404, msg)
|
||||
request_mock.return_value = (1, {}, {})
|
||||
request_mock.side_effect = exc
|
||||
self._test_trace_error(StatusCanonicalCode.NOT_FOUND, exc)
|
||||
|
||||
def _test_trace_error(self, code, exc):
|
||||
es = Elasticsearch()
|
||||
try:
|
||||
es.get(index="test-index", doc_type="tweet", id=1)
|
||||
except Exception: # pylint: disable=broad-except
|
||||
pass
|
||||
|
||||
spans = self.get_ordered_finished_spans()
|
||||
self.assertEqual(1, len(spans))
|
||||
span = spans[0]
|
||||
self.assertFalse(span.status.is_ok)
|
||||
self.assertEqual(span.status.canonical_code, code)
|
||||
self.assertEqual(span.status.description, str(exc))
|
||||
|
||||
def test_parent(self, request_mock):
|
||||
request_mock.return_value = (1, {}, {})
|
||||
es = Elasticsearch()
|
||||
with self.tracer.start_as_current_span("parent"):
|
||||
es.index(
|
||||
index="sw", doc_type="people", id=1, body={"name": "adam"}
|
||||
)
|
||||
|
||||
spans = self.get_ordered_finished_spans()
|
||||
self.assertEqual(len(spans), 2)
|
||||
|
||||
self.assertEqual(spans[0].name, "parent")
|
||||
self.assertEqual(spans[1].name, "Elasticsearch/sw/people/1")
|
||||
self.assertIsNotNone(spans[1].parent)
|
||||
self.assertEqual(spans[1].parent.span_id, spans[0].context.span_id)
|
||||
|
||||
def test_multithread(self, request_mock):
|
||||
request_mock.return_value = (1, {}, {})
|
||||
es = Elasticsearch()
|
||||
ev = threading.Event()
|
||||
|
||||
# 1. Start tracing from thread-1; make thread-2 wait
|
||||
# 2. Trace something from thread-2, make thread-1 join before finishing.
|
||||
# 3. Check the spans got different parents, and are in the expected order.
|
||||
def target1(parent_span):
|
||||
with self.tracer.use_span(parent_span):
|
||||
es.get(index="test-index", doc_type="tweet", id=1)
|
||||
ev.set()
|
||||
ev.wait()
|
||||
|
||||
def target2():
|
||||
ev.wait()
|
||||
es.get(index="test-index", doc_type="tweet", id=2)
|
||||
ev.set()
|
||||
|
||||
with self.tracer.start_as_current_span("parent") as span:
|
||||
t1 = threading.Thread(target=target1, args=(span,))
|
||||
t1.start()
|
||||
|
||||
t2 = threading.Thread(target=target2)
|
||||
t2.start()
|
||||
t1.join()
|
||||
t2.join()
|
||||
|
||||
spans = self.get_ordered_finished_spans()
|
||||
self.assertEqual(3, len(spans))
|
||||
s1, s2, s3 = spans
|
||||
|
||||
self.assertEqual(s1.name, "parent")
|
||||
|
||||
self.assertEqual(s2.name, "Elasticsearch/test-index/tweet/1")
|
||||
self.assertIsNotNone(s2.parent)
|
||||
self.assertEqual(s2.parent.span_id, s1.context.span_id)
|
||||
self.assertEqual(s3.name, "Elasticsearch/test-index/tweet/2")
|
||||
self.assertIsNone(s3.parent)
|
||||
|
||||
def test_dsl_search(self, request_mock):
|
||||
request_mock.return_value = (1, {}, '{"hits": {"hits": []}}')
|
||||
|
||||
client = Elasticsearch()
|
||||
search = Search(using=client, index="test-index").filter(
|
||||
"term", author="testing"
|
||||
)
|
||||
search.execute()
|
||||
spans = self.get_ordered_finished_spans()
|
||||
span = spans[0]
|
||||
self.assertEqual(1, len(spans))
|
||||
self.assertEqual(span.name, "Elasticsearch/test-index/_search")
|
||||
self.assertIsNotNone(span.end_time)
|
||||
self.assertEqual(
|
||||
span.attributes,
|
||||
{
|
||||
"component": "elasticsearch-py",
|
||||
"db.type": "elasticsearch",
|
||||
"elasticsearch.url": "/test-index/_search",
|
||||
"elasticsearch.method": helpers.dsl_search_method,
|
||||
"db.statement": str(
|
||||
{
|
||||
"query": {
|
||||
"bool": {
|
||||
"filter": [{"term": {"author": "testing"}}]
|
||||
}
|
||||
}
|
||||
}
|
||||
),
|
||||
},
|
||||
)
|
||||
|
||||
def test_dsl_create(self, request_mock):
|
||||
request_mock.return_value = (1, {}, {})
|
||||
client = Elasticsearch()
|
||||
Article.init(using=client)
|
||||
|
||||
spans = self.get_ordered_finished_spans()
|
||||
self.assertEqual(2, len(spans))
|
||||
span1, span2 = spans
|
||||
self.assertEqual(span1.name, "Elasticsearch/test-index")
|
||||
self.assertEqual(
|
||||
span1.attributes,
|
||||
{
|
||||
"component": "elasticsearch-py",
|
||||
"db.type": "elasticsearch",
|
||||
"elasticsearch.url": "/test-index",
|
||||
"elasticsearch.method": "HEAD",
|
||||
},
|
||||
)
|
||||
|
||||
self.assertEqual(span2.name, "Elasticsearch/test-index")
|
||||
attributes = {
|
||||
"component": "elasticsearch-py",
|
||||
"db.type": "elasticsearch",
|
||||
"elasticsearch.url": "/test-index",
|
||||
"elasticsearch.method": "PUT",
|
||||
}
|
||||
self.assert_span_has_attributes(span2, attributes)
|
||||
self.assertEqual(
|
||||
literal_eval(span2.attributes["db.statement"]),
|
||||
helpers.dsl_create_statement,
|
||||
)
|
||||
|
||||
def test_dsl_index(self, request_mock):
|
||||
request_mock.return_value = helpers.dsl_index_result
|
||||
|
||||
client = Elasticsearch()
|
||||
article = Article(
|
||||
meta={"id": 2},
|
||||
title="About searching",
|
||||
body="A few words here, a few words there",
|
||||
)
|
||||
res = article.save(using=client)
|
||||
self.assertTrue(res)
|
||||
spans = self.get_ordered_finished_spans()
|
||||
self.assertEqual(1, len(spans))
|
||||
span = spans[0]
|
||||
self.assertEqual(span.name, helpers.dsl_index_span_name)
|
||||
attributes = {
|
||||
"component": "elasticsearch-py",
|
||||
"db.type": "elasticsearch",
|
||||
"elasticsearch.url": helpers.dsl_index_url,
|
||||
"elasticsearch.method": "PUT",
|
||||
}
|
||||
self.assert_span_has_attributes(span, attributes)
|
||||
self.assertEqual(
|
||||
literal_eval(span.attributes["db.statement"]),
|
||||
{
|
||||
"body": "A few words here, a few words there",
|
||||
"title": "About searching",
|
||||
},
|
||||
)
|
||||
Reference in New Issue
Block a user