feat: Add elasticsearch instrumentation by CagriYonca · Pull Request #882 · instana/python-sensor

CagriYonca · 2026-06-18T09:19:59Z

Added elasticsearch instrumentation.

github-actions · 2026-06-18T09:20:09Z

❌ @CagriYonca the signed-off-by was not found in the following 1 commits:

99fcfab: feat: Add elasticsearch instrumentation

📝 What should I do to fix it?

All proposed commits should include a sign-off in their messages, ideally at the end.

❔ Why it is required

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:

By making a contribution to this project, I certify that:

a. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

b. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

c. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

d. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

This is my commit message

Signed-off-by: Random Developer <randomdeveloper@example.com>

Git even has a -s command line option to append this automatically to your commit message:

$ git commit -s -m 'This is my commit message'

pvital · 2026-06-23T12:54:38Z

+
+    # Connection cache to avoid repeated URL parsing and store cluster info
+    # Structure: {connection_id: {host, port, cluster_name, last_updated}}
+    _connection_cache: dict[str, dict[str, Any]] = {}


Suggestion. You can use defaultdict to create _connection_cache, then you can better manage the usage of the dictionary. But remember, if asking for a missing key _connection_cache, it will return an empty dictionary. WDYT?

Suggested change

_connection_cache: dict[str, dict[str, Any]] = {}

_connection_cache: dict[str, dict[str, Any]] = defaultdict(dict)

pvital · 2026-06-23T12:57:04Z

+        if connection_id in _connection_cache:
+            cached = _connection_cache[connection_id]
+            cluster_name = cached.get("cluster_name")
+            if (
+                cluster_name
+                and (time.time() - cached.get("last_updated", 0))
+                < CLUSTER_NAME_CACHE_TTL
+            ):
+                return cluster_name


By using defaultdict as suggested before, you can reduce this code to:

Suggested change

if connection_id in _connection_cache:

cached = _connection_cache[connection_id]

cluster_name = cached.get("cluster_name")

if (

cluster_name

and (time.time() - cached.get("last_updated", 0))

< CLUSTER_NAME_CACHE_TTL

):

return cluster_name

if cached := _connection_cache[connection_id]:

if (cluster_name := cached.get("cluster_name")) and (time.time() - cached.get("last_updated", 0) < CLUSTER_NAME_CACHE_TTL:

return cluster_name

Doesn't the walrus operator make it harder to read?

pvital · 2026-06-23T13:04:55Z

+            cached = _get_cached_cluster_name(connection_id)
+            if cached:
+                return cached


Suggested change

cached = _get_cached_cluster_name(connection_id)

if cached:

return cached

if cached := _get_cached_cluster_name(connection_id):

return cached

pvital · 2026-06-23T13:06:04Z

+                    cluster_name = _extract_cluster_name_from_response(instance.info())
+                    if cluster_name:


Suggested change

cluster_name = _extract_cluster_name_from_response(instance.info())

if cluster_name:

if cluster_name := _extract_cluster_name_from_response(instance.info())

pvital · 2026-06-23T13:13:52Z

+            url_lower = url.lower()
+
+            # Multi-operations
+            if "_msearch" in url_lower:
+                return "msearch"
+            if "_mget" in url_lower:
+                return "mget"
+            if "_bulk" in url_lower:
+                return "bulk"
+
+            # Search operations
+            if "_search" in url_lower:
+                return "search"
+


SonarCloud reported a Cognitive Complexity in this function due to the many if statements. Why not use something like:

Suggested change

url_lower = url.lower()

# Multi-operations

if "_msearch" in url_lower:

return "msearch"

if "_mget" in url_lower:

return "mget"

if "_bulk" in url_lower:

return "bulk"

# Search operations

if "_search" in url_lower:

return "search"

url_lower = url.lower()

if url_lower.startswith("_"):

return url_lower[1,]

pvital · 2026-06-23T13:28:53Z

+                # Response status code
+                if hasattr(response, "meta") and hasattr(response.meta, "status"):
+                    status_code = response.meta.status
+                    span.set_attribute(SpanAttributes.HTTP_STATUS_CODE, status_code)


Why do we set the HTTP status code attribute since this is a DB-type operation?

You're right, it uses urllib3 to make DB calls but semantically DB span shouldn't have HTTP_STATUS_CODE. It's been removed

Signed-off-by: Cagri Yonca <cagri@ibm.com>

sonarqubecloud · 2026-06-23T15:36:52Z

Quality Gate passed

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
97.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

CagriYonca self-assigned this Jun 18, 2026

CagriYonca requested a review from a team as a code owner June 18, 2026 09:19

CagriYonca added the feature label Jun 18, 2026

GSVarsha reviewed Jun 18, 2026

View reviewed changes

Comment thread src/instana/span/registered_span.py

CagriYonca force-pushed the elasticsearch branch from 99fcfab to e9c685e Compare June 18, 2026 12:02

CagriYonca requested a review from GSVarsha June 18, 2026 12:03

pvital reviewed Jun 23, 2026

View reviewed changes

CagriYonca force-pushed the elasticsearch branch from e9c685e to e9b97d8 Compare June 23, 2026 13:59

refactor: Refactor span registration blocks

99b6965

Signed-off-by: Cagri Yonca <cagri@ibm.com>

CagriYonca force-pushed the elasticsearch branch 2 times, most recently from eb46efa to 4b3de8a Compare June 23, 2026 15:20

CagriYonca requested a review from pvital June 23, 2026 15:23

feat: Add elasticsearch instrumentation

b7d765a

Signed-off-by: Cagri Yonca <cagri@ibm.com>

CagriYonca force-pushed the elasticsearch branch from 4b3de8a to b7d765a Compare June 23, 2026 15:28

	_connection_cache: dict[str, dict[str, Any]] = {}
	_connection_cache: dict[str, dict[str, Any]] = defaultdict(dict)

		cluster_name = _extract_cluster_name_from_response(instance.info())
		if cluster_name:

	cluster_name = _extract_cluster_name_from_response(instance.info())
	if cluster_name:
	if cluster_name := _extract_cluster_name_from_response(instance.info())

Conversation

CagriYonca commented Jun 18, 2026

Uh oh!

github-actions Bot commented Jun 18, 2026

📝 What should I do to fix it?

❔ Why it is required

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jun 23, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants