openlit 1.34.25__py3-none-any.whl → 1.34.27__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,102 +1,277 @@
1
1
  """
2
- Astra OpenTelemetry instrumentation utility functions
2
+ Utility functions for AstraDB instrumentation.
3
3
  """
4
4
 
5
5
  import time
6
- import logging
6
+ from urllib.parse import urlparse
7
7
  from opentelemetry.trace import Status, StatusCode
8
- from opentelemetry.sdk.resources import SERVICE_NAME, TELEMETRY_SDK_NAME, DEPLOYMENT_ENVIRONMENT
9
- from openlit.__helpers import handle_exception
8
+ from openlit.__helpers import (
9
+ common_db_span_attributes,
10
+ record_db_metrics,
11
+ )
10
12
  from openlit.semcov import SemanticConvention
11
13
 
12
- # Initialize logger for logging potential issues and operations
13
- logger = logging.getLogger(__name__)
14
+ # Operation mapping for simple span naming
15
+ DB_OPERATION_MAP = {
16
+ "astra.create_collection": SemanticConvention.DB_OPERATION_CREATE_COLLECTION,
17
+ "astra.drop_collection": SemanticConvention.DB_OPERATION_DELETE_COLLECTION,
18
+ "astra.insert": SemanticConvention.DB_OPERATION_INSERT,
19
+ "astra.insert_one": SemanticConvention.DB_OPERATION_INSERT,
20
+ "astra.insert_many": SemanticConvention.DB_OPERATION_INSERT,
21
+ "astra.update": SemanticConvention.DB_OPERATION_UPDATE,
22
+ "astra.update_one": SemanticConvention.DB_OPERATION_UPDATE,
23
+ "astra.update_many": SemanticConvention.DB_OPERATION_UPDATE,
24
+ "astra.find": SemanticConvention.DB_OPERATION_SELECT,
25
+ "astra.find_one_and_update": SemanticConvention.DB_OPERATION_REPLACE,
26
+ "astra.replace_one": SemanticConvention.DB_OPERATION_REPLACE,
27
+ "astra.find_one_and_delete": SemanticConvention.DB_OPERATION_FIND_AND_DELETE,
28
+ "astra.delete": SemanticConvention.DB_OPERATION_DELETE,
29
+ "astra.delete_one": SemanticConvention.DB_OPERATION_DELETE,
30
+ "astra.delete_many": SemanticConvention.DB_OPERATION_DELETE,
31
+ }
14
32
 
15
33
  def object_count(obj):
16
- """Counts Length of object if it exists, Else returns None."""
17
- return len(obj) if isinstance(obj, list) else 1
34
+ """
35
+ Counts length of object if it exists, else returns 0.
36
+ """
37
+ if isinstance(obj, list):
38
+ return len(obj)
39
+ elif obj is not None:
40
+ return 1
41
+ return 0
18
42
 
19
- DB_OPERATION_MAP = {
20
- 'astra.create_collection': SemanticConvention.DB_OPERATION_CREATE_COLLECTION,
21
- 'astra.drop_collection': SemanticConvention.DB_OPERATION_DELETE_COLLECTION,
22
- 'astra.insert': SemanticConvention.DB_OPERATION_INSERT,
23
- 'astra.update': SemanticConvention.DB_OPERATION_UPDATE,
24
- 'astra.find': SemanticConvention.DB_OPERATION_SELECT,
25
- 'astra.find_one_and_update': SemanticConvention.DB_OPERATION_REPLACE,
26
- 'astra.replace_one': SemanticConvention.DB_OPERATION_REPLACE,
27
- 'astra.delete': SemanticConvention.DB_OPERATION_DELETE,
28
- 'astra.find_one_and_delete': SemanticConvention.DB_OPERATION_FIND_AND_DELETE
29
- }
43
+ def set_server_address_and_port(instance):
44
+ """
45
+ Extracts server address and port from AstraDB client instance.
46
+
47
+ Args:
48
+ instance: AstraDB client instance
49
+
50
+ Returns:
51
+ tuple: (server_address, server_port)
52
+ """
53
+ server_address = "astra.datastax.com"
54
+ server_port = 443
55
+
56
+ # Try getting api_endpoint from instance or its database
57
+ api_endpoint = getattr(instance, "api_endpoint", None)
58
+ if not api_endpoint:
59
+ # Try getting from database attribute
60
+ database = getattr(instance, "database", None)
61
+ if database:
62
+ api_endpoint = getattr(database, "api_endpoint", None)
63
+
64
+ if api_endpoint and isinstance(api_endpoint, str):
65
+ if api_endpoint.startswith(("http://", "https://")):
66
+ try:
67
+ parsed = urlparse(api_endpoint)
68
+ server_address = parsed.hostname or server_address
69
+ server_port = parsed.port or server_port
70
+ except Exception:
71
+ pass
72
+ else:
73
+ # Handle cases like "hostname:port" or just "hostname"
74
+ if ":" in api_endpoint:
75
+ parts = api_endpoint.split(":")
76
+ server_address = parts[0]
77
+ try:
78
+ server_port = int(parts[1])
79
+ except (ValueError, IndexError):
80
+ pass
81
+ else:
82
+ server_address = api_endpoint
83
+
84
+ return server_address, server_port
30
85
 
31
- def process_db_operations(response, span, start_time, gen_ai_endpoint,
32
- version, environment, application_name,
33
- capture_message_content, metrics, disable_metrics, server_address,
34
- server_port, collection_name, db_operation, kwargs, args):
86
+ def common_astra_logic(scope, environment, application_name,
87
+ metrics, capture_message_content, disable_metrics, version,
88
+ instance=None, endpoint=None):
35
89
  """
36
- Process DB operation and generate Telemetry
90
+ Process AstraDB request and generate telemetry.
91
+
92
+ Args:
93
+ scope: Scope object containing span, response, and operation details
94
+ environment: Deployment environment
95
+ application_name: Name of the application
96
+ metrics: Metrics dictionary for recording telemetry
97
+ capture_message_content: Flag to capture message content
98
+ disable_metrics: Flag to disable metrics collection
99
+ version: Version of the AstraDB client
100
+ instance: AstraDB client instance
101
+ endpoint: Operation endpoint for differentiation
37
102
  """
103
+ scope._end_time = time.time()
104
+
105
+ # Set common database span attributes using helper
106
+ common_db_span_attributes(scope, SemanticConvention.DB_SYSTEM_ASTRA,
107
+ scope._server_address, scope._server_port, environment, application_name, version)
108
+
109
+ # Set DB operation specific attributes
110
+ scope._span.set_attribute(SemanticConvention.DB_OPERATION_NAME, scope._db_operation)
111
+ scope._span.set_attribute(SemanticConvention.DB_CLIENT_OPERATION_DURATION,
112
+ scope._end_time - scope._start_time)
113
+
114
+ # Get collection name from instance
115
+ collection_name = getattr(instance, "name", "unknown")
116
+ scope._span.set_attribute(SemanticConvention.DB_COLLECTION_NAME, collection_name)
117
+
118
+ if scope._db_operation == SemanticConvention.DB_OPERATION_CREATE_COLLECTION:
119
+ # Handle create_collection operation
120
+ scope._span.set_attribute(SemanticConvention.DB_COLLECTION_DIMENSION,
121
+ scope._kwargs.get("dimension", -1))
122
+ scope._span.set_attribute(SemanticConvention.DB_INDEX_METRIC,
123
+ str(scope._kwargs.get("metric", "")))
124
+
125
+ # Set namespace if available in response
126
+ if scope._response and hasattr(scope._response, "keyspace"):
127
+ scope._span.set_attribute(SemanticConvention.DB_NAMESPACE, scope._response.keyspace)
128
+
129
+ if scope._response and hasattr(scope._response, "name"):
130
+ scope._span.set_attribute(SemanticConvention.DB_COLLECTION_NAME, scope._response.name)
131
+
132
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
133
+ f"{scope._db_operation} {collection_name} "
134
+ f"dimension={scope._kwargs.get('dimension', 'None')} "
135
+ f"metric={scope._kwargs.get('metric', 'None')}")
136
+
137
+ elif scope._db_operation == SemanticConvention.DB_OPERATION_DELETE_COLLECTION:
138
+ # Handle drop_collection operation
139
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
140
+ f"{scope._db_operation} {collection_name}")
141
+
142
+ elif scope._db_operation == SemanticConvention.DB_OPERATION_INSERT:
143
+ # Handle insert operations (insert_one, insert_many, regular insert)
144
+ documents = scope._args[0] if scope._args else scope._kwargs.get("documents", [])
145
+
146
+ scope._span.set_attribute(SemanticConvention.DB_DOCUMENTS_COUNT, object_count(documents))
147
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(documents))
148
+
149
+ # Response metrics
150
+ if scope._response and hasattr(scope._response, "inserted_ids"):
151
+ scope._span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS,
152
+ len(scope._response.inserted_ids))
153
+
154
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
155
+ f"{scope._db_operation} {collection_name} "
156
+ f"documents_count={object_count(documents)}")
157
+
158
+ elif scope._db_operation == SemanticConvention.DB_OPERATION_UPDATE:
159
+ # Handle update operations (update_one, update_many, regular update)
160
+ update_query = scope._args[1] if len(scope._args) > 1 else scope._kwargs.get("update", {})
161
+ filter_query = scope._args[0] if scope._args else scope._kwargs.get("filter", {})
162
+
163
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(update_query))
164
+ scope._span.set_attribute(SemanticConvention.DB_FILTER, str(filter_query))
165
+
166
+ # Response metrics
167
+ if scope._response and hasattr(scope._response, "update_info"):
168
+ scope._span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS,
169
+ scope._response.update_info.get("nModified", 0))
170
+
171
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
172
+ f"{scope._db_operation} {collection_name} "
173
+ f"filter={str(filter_query)[:100]}... "
174
+ f"update={str(update_query)[:100]}...")
175
+
176
+ elif scope._db_operation == SemanticConvention.DB_OPERATION_REPLACE:
177
+ # Handle replace operations (find_one_and_update, replace_one)
178
+ filter_query = scope._args[0] if scope._args else scope._kwargs.get("filter", {})
179
+
180
+ # Check if it's an upsert operation
181
+ if scope._kwargs.get("upsert"):
182
+ scope._db_operation = SemanticConvention.DB_OPERATION_UPSERT
183
+ scope._span.set_attribute(SemanticConvention.DB_OPERATION_NAME,
184
+ SemanticConvention.DB_OPERATION_UPSERT)
185
+
186
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(filter_query))
187
+ scope._span.set_attribute(SemanticConvention.DB_FILTER, str(filter_query))
188
+
189
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
190
+ f"{scope._db_operation} {collection_name} "
191
+ f"filter={str(filter_query)[:100]}... "
192
+ f"upsert={scope._kwargs.get('upsert', False)}")
193
+
194
+ elif scope._db_operation == SemanticConvention.DB_OPERATION_SELECT:
195
+ # Handle find operations
196
+ filter_query = scope._args[0] if scope._args else scope._kwargs.get("filter", {})
197
+
198
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(filter_query))
199
+ scope._span.set_attribute(SemanticConvention.DB_FILTER, str(filter_query))
200
+
201
+ # Response metrics
202
+ if scope._response and hasattr(scope._response, "__len__"):
203
+ scope._span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS,
204
+ len(scope._response))
205
+
206
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
207
+ f"{scope._db_operation} {collection_name} "
208
+ f"filter={str(filter_query)[:100]}...")
209
+
210
+ elif scope._db_operation in [SemanticConvention.DB_OPERATION_DELETE,
211
+ SemanticConvention.DB_OPERATION_FIND_AND_DELETE]:
212
+ # Handle delete operations (delete_one, delete_many, find_one_and_delete)
213
+ filter_query = scope._args[0] if scope._args else scope._kwargs.get("filter", {})
214
+
215
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(filter_query))
216
+ scope._span.set_attribute(SemanticConvention.DB_FILTER, str(filter_query))
217
+
218
+ # Response metrics
219
+ if scope._response and hasattr(scope._response, "deleted_count"):
220
+ scope._span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS,
221
+ scope._response.deleted_count)
222
+
223
+ scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
224
+ f"{scope._db_operation} {collection_name} "
225
+ f"filter={str(filter_query)[:100]}...")
226
+
227
+ scope._span.set_status(Status(StatusCode.OK))
228
+
229
+ # Record metrics using helper
230
+ if not disable_metrics:
231
+ record_db_metrics(metrics, SemanticConvention.DB_SYSTEM_ASTRA,
232
+ scope._server_address, scope._server_port, environment, application_name,
233
+ scope._start_time, scope._end_time)
234
+
235
+ def process_astra_response(response, db_operation, server_address, server_port,
236
+ environment, application_name, metrics, start_time, span,
237
+ capture_message_content, disable_metrics, version, instance, args, **kwargs):
238
+ """
239
+ Process AstraDB response and generate telemetry.
240
+
241
+ Args:
242
+ response: Response from AstraDB operation
243
+ db_operation: Database operation type
244
+ server_address: Server address
245
+ server_port: Server port
246
+ environment: Deployment environment
247
+ application_name: Application name
248
+ metrics: Metrics dictionary
249
+ start_time: Start time of the operation
250
+ span: OpenTelemetry span
251
+ capture_message_content: Flag to capture message content
252
+ disable_metrics: Flag to disable metrics
253
+ version: AstraDB client version
254
+ instance: AstraDB client instance
255
+ args: Positional arguments
256
+ **kwargs: Keyword arguments
257
+
258
+ Returns:
259
+ Original response
260
+ """
261
+
262
+ # Create a scope object to hold all the context
263
+ scope = type("GenericScope", (), {})()
264
+ scope._response = response
265
+ scope._db_operation = db_operation
266
+ scope._server_address = server_address
267
+ scope._server_port = server_port
268
+ scope._start_time = start_time
269
+ scope._span = span
270
+ scope._kwargs = kwargs
271
+ scope._args = args
272
+
273
+ # Process the response using common logic
274
+ common_astra_logic(scope, environment, application_name,
275
+ metrics, capture_message_content, disable_metrics, version, instance)
38
276
 
39
- end_time = time.time()
40
-
41
- try:
42
- span.set_attribute(TELEMETRY_SDK_NAME, 'openlit')
43
- span.set_attribute(SemanticConvention.GEN_AI_OPERATION, SemanticConvention.GEN_AI_OPERATION_TYPE_VECTORDB)
44
- span.set_attribute(SemanticConvention.DB_SYSTEM_NAME, SemanticConvention.DB_SYSTEM_ASTRA)
45
- span.set_attribute(SemanticConvention.DB_CLIENT_OPERATION_DURATION, end_time - start_time)
46
- span.set_attribute(SemanticConvention.SERVER_ADDRESS, server_address)
47
- span.set_attribute(SemanticConvention.SERVER_PORT, server_port)
48
- span.set_attribute(DEPLOYMENT_ENVIRONMENT, environment)
49
- span.set_attribute(SERVICE_NAME, application_name)
50
- span.set_attribute(SemanticConvention.DB_OPERATION_NAME, db_operation)
51
- span.set_attribute(SemanticConvention.DB_COLLECTION_NAME, collection_name)
52
- span.set_attribute(SemanticConvention.DB_SDK_VERSION, version)
53
-
54
- if db_operation == SemanticConvention.DB_OPERATION_CREATE_COLLECTION:
55
- span.set_attribute(SemanticConvention.DB_NAMESPACE, response.keyspace)
56
- span.set_attribute(SemanticConvention.DB_COLLECTION_NAME, response.name)
57
- span.set_attribute(SemanticConvention.DB_INDEX_DIMENSION, kwargs.get('dimension', ''))
58
- span.set_attribute(SemanticConvention.DB_INDEX_METRIC, str(kwargs.get('metric', '')))
59
-
60
- if db_operation == SemanticConvention.DB_OPERATION_INSERT:
61
- span.set_attribute(SemanticConvention.DB_DOCUMENTS_COUNT, object_count(args[0]))
62
- span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(args[0] or kwargs.get('documents', {})))
63
-
64
- elif db_operation == SemanticConvention.DB_OPERATION_UPDATE:
65
- span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS, response.update_info.get('nModified', 0))
66
- span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(args[1] or kwargs.get('update', {})))
67
-
68
- elif db_operation == SemanticConvention.DB_OPERATION_DELETE:
69
- span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS, response.deleted_count)
70
- span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(args[0] or kwargs.get('filter', {})))
71
-
72
- elif db_operation in [
73
- SemanticConvention.DB_OPERATION_SELECT,
74
- SemanticConvention.DB_OPERATION_FIND_AND_DELETE,
75
- SemanticConvention.DB_OPERATION_REPLACE
76
- ]:
77
- span.set_attribute(SemanticConvention.DB_QUERY_TEXT, str(args or kwargs.get('filter', {})))
78
-
79
- span.set_status(Status(StatusCode.OK))
80
-
81
- if not disable_metrics:
82
- attributes = {
83
- TELEMETRY_SDK_NAME: 'openlit',
84
- SERVICE_NAME: application_name,
85
- SemanticConvention.DB_SYSTEM_NAME: SemanticConvention.DB_SYSTEM_ASTRA,
86
- DEPLOYMENT_ENVIRONMENT: environment,
87
- SemanticConvention.GEN_AI_OPERATION: SemanticConvention.GEN_AI_OPERATION_TYPE_VECTORDB,
88
- SemanticConvention.DB_OPERATION_NAME: db_operation
89
- }
90
-
91
- metrics['db_requests'].add(1, attributes)
92
- metrics['db_client_operation_duration'].record(end_time - start_time, attributes)
93
-
94
- # Return original response
95
- return response
96
-
97
- except Exception as e:
98
- handle_exception(span, e)
99
- logger.error('Error in trace creation: %s', e)
100
-
101
- # Return original response
102
- return response
277
+ return response
@@ -13,7 +13,7 @@ _instruments = ("chromadb >= 0.4.0",)
13
13
 
14
14
  class ChromaInstrumentor(BaseInstrumentor):
15
15
  """
16
- An instrumentor for ChromaDB's client library.
16
+ An instrumentor for ChromaDB client library.
17
17
  """
18
18
 
19
19
  def instrumentation_dependencies(self) -> Collection[str]:
@@ -5,13 +5,11 @@ Module for monitoring ChromaDB API calls.
5
5
  import time
6
6
  from opentelemetry.trace import SpanKind
7
7
  from opentelemetry import context as context_api
8
- from openlit.__helpers import (
9
- handle_exception,
10
- set_server_address_and_port,
11
- )
8
+ from openlit.__helpers import handle_exception
12
9
  from openlit.instrumentation.chroma.utils import (
13
10
  process_vectordb_response,
14
11
  DB_OPERATION_MAP,
12
+ set_server_address_and_port,
15
13
  )
16
14
 
17
15
  def general_wrap(gen_ai_endpoint, version, environment, application_name,
@@ -29,7 +27,7 @@ def general_wrap(gen_ai_endpoint, version, environment, application_name,
29
27
  return wrapped(*args, **kwargs)
30
28
 
31
29
  # Get server address and port using the standard helper
32
- server_address, server_port = set_server_address_and_port(instance, "localhost", 8000)
30
+ server_address, server_port = set_server_address_and_port(instance)
33
31
 
34
32
  db_operation = DB_OPERATION_MAP.get(gen_ai_endpoint, "unknown")
35
33
  if db_operation == "create_collection":
@@ -39,10 +37,10 @@ def general_wrap(gen_ai_endpoint, version, environment, application_name,
39
37
  span_name = f"{db_operation} {namespace}"
40
38
 
41
39
  with tracer.start_as_current_span(span_name, kind=SpanKind.CLIENT) as span:
42
- try:
43
- start_time = time.time()
44
- response = wrapped(*args, **kwargs)
40
+ start_time = time.time()
41
+ response = wrapped(*args, **kwargs)
45
42
 
43
+ try:
46
44
  # Process response and generate telemetry
47
45
  response = process_vectordb_response(
48
46
  response, db_operation, server_address, server_port,
@@ -2,7 +2,7 @@
2
2
  ChromaDB OpenTelemetry instrumentation utility functions
3
3
  """
4
4
  import time
5
-
5
+ from urllib.parse import urlparse
6
6
  from opentelemetry.trace import Status, StatusCode
7
7
 
8
8
  from openlit.__helpers import (
@@ -29,6 +29,51 @@ def object_count(obj):
29
29
  """
30
30
  return len(obj) if obj else 0
31
31
 
32
+ def set_server_address_and_port(instance):
33
+ """
34
+ Extracts server address and port from ChromaDB client instance.
35
+
36
+ Args:
37
+ instance: ChromaDB client instance
38
+
39
+ Returns:
40
+ tuple: (server_address, server_port)
41
+ """
42
+ server_address = "localhost"
43
+ server_port = 8000
44
+
45
+ # Try getting base_url from multiple potential attributes
46
+ base_client = getattr(instance, "_client", None)
47
+ base_url = getattr(base_client, "base_url", None)
48
+
49
+ if not base_url:
50
+ # Attempt to get endpoint from instance._config.endpoint
51
+ config = getattr(instance, "_config", None)
52
+ base_url = getattr(config, "endpoint", None)
53
+
54
+ if not base_url:
55
+ # Attempt to get server_url from instance.sdk_configuration.server_url
56
+ config = getattr(instance, "sdk_configuration", None)
57
+ base_url = getattr(config, "server_url", None)
58
+
59
+ if base_url:
60
+ if isinstance(base_url, str):
61
+ # Check if it a full URL or just a hostname
62
+ if base_url.startswith(("http://", "https://")):
63
+ try:
64
+ url = urlparse(base_url)
65
+ if url.hostname:
66
+ server_address = url.hostname
67
+ if url.port:
68
+ server_port = url.port
69
+ except Exception:
70
+ pass
71
+ else:
72
+ # Just a hostname
73
+ server_address = base_url
74
+
75
+ return server_address, server_port
76
+
32
77
  def common_vectordb_logic(scope, environment, application_name,
33
78
  metrics, capture_message_content, disable_metrics, version, instance=None, endpoint=None):
34
79
  """
@@ -120,8 +165,8 @@ def common_vectordb_logic(scope, environment, application_name,
120
165
  # Extract response metrics if available
121
166
  if scope._response:
122
167
  # Get number of results returned
123
- if hasattr(scope._response, 'get') and scope._response.get('ids'):
124
- returned_rows = object_count(scope._response['ids'][0]) if scope._response['ids'] else 0
168
+ if hasattr(scope._response, "get") and scope._response.get("ids"):
169
+ returned_rows = object_count(scope._response["ids"][0]) if scope._response["ids"] else 0
125
170
  scope._span.set_attribute(SemanticConvention.DB_RESPONSE_RETURNED_ROWS, returned_rows)
126
171
 
127
172
  scope._span.set_attribute(SemanticConvention.DB_QUERY_SUMMARY,
@@ -1,5 +1,7 @@
1
- # pylint: disable=useless-return, bad-staticmethod-argument, disable=duplicate-code
2
- """Initializer of Auto Instrumentation of Milvus Functions"""
1
+ """
2
+ OpenLIT Milvus Instrumentation
3
+ """
4
+
3
5
  from typing import Collection
4
6
  import importlib.metadata
5
7
  from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
@@ -9,86 +11,46 @@ from openlit.instrumentation.milvus.milvus import general_wrap
9
11
 
10
12
  _instruments = ("pymilvus >= 2.4.3",)
11
13
 
12
- WRAPPED_METHODS = [
13
- {
14
- "package": "pymilvus",
15
- "object": "MilvusClient.create_collection",
16
- "endpoint": "milvus.create_collection",
17
- "wrapper": general_wrap,
18
- },
19
- {
20
- "package": "pymilvus",
21
- "object": "MilvusClient.drop_collection",
22
- "endpoint": "milvus.drop_collection",
23
- "wrapper": general_wrap,
24
- },
25
- {
26
- "package": "pymilvus",
27
- "object": "MilvusClient.insert",
28
- "endpoint": "milvus.insert",
29
- "wrapper": general_wrap,
30
- },
31
- {
32
- "package": "pymilvus",
33
- "object": "MilvusClient.upsert",
34
- "endpoint": "milvus.upsert",
35
- "wrapper": general_wrap,
36
- },
37
- {
38
- "package": "pymilvus",
39
- "object": "MilvusClient.search",
40
- "endpoint": "milvus.search",
41
- "wrapper": general_wrap,
42
- },
43
- {
44
- "package": "pymilvus",
45
- "object": "MilvusClient.query",
46
- "endpoint": "milvus.query",
47
- "wrapper": general_wrap,
48
- },
49
- {
50
- "package": "pymilvus",
51
- "object": "MilvusClient.get",
52
- "endpoint": "milvus.get",
53
- "wrapper": general_wrap,
54
- },
55
- {
56
- "package": "pymilvus",
57
- "object": "MilvusClient.delete",
58
- "endpoint": "milvus.delete",
59
- "wrapper": general_wrap,
60
- },
14
+ # Operations to wrap for Milvus client
15
+ MILVUS_OPERATIONS = [
16
+ ("create_collection", "milvus.create_collection"),
17
+ ("drop_collection", "milvus.drop_collection"),
18
+ ("insert", "milvus.insert"),
19
+ ("upsert", "milvus.upsert"),
20
+ ("search", "milvus.search"),
21
+ ("query", "milvus.query"),
22
+ ("get", "milvus.get"),
23
+ ("delete", "milvus.delete"),
61
24
  ]
62
25
 
63
26
  class MilvusInstrumentor(BaseInstrumentor):
64
- """An instrumentor for Milvus's client library."""
27
+ """
28
+ An instrumentor for Milvus's client library.
29
+ """
65
30
 
66
31
  def instrumentation_dependencies(self) -> Collection[str]:
67
32
  return _instruments
68
33
 
69
34
  def _instrument(self, **kwargs):
70
- application_name = kwargs.get("application_name")
71
- environment = kwargs.get("environment")
35
+ version = importlib.metadata.version("pymilvus")
36
+ environment = kwargs.get("environment", "default")
37
+ application_name = kwargs.get("application_name", "default")
72
38
  tracer = kwargs.get("tracer")
39
+ pricing_info = kwargs.get("pricing_info", {})
40
+ capture_message_content = kwargs.get("capture_message_content", False)
73
41
  metrics = kwargs.get("metrics_dict")
74
- pricing_info = kwargs.get("pricing_info")
75
- capture_message_content = kwargs.get("capture_message_content")
76
42
  disable_metrics = kwargs.get("disable_metrics")
77
- version = importlib.metadata.version("pymilvus")
78
43
 
79
- for wrapped_method in WRAPPED_METHODS:
80
- wrap_package = wrapped_method.get("package")
81
- wrap_object = wrapped_method.get("object")
82
- gen_ai_endpoint = wrapped_method.get("endpoint")
83
- wrapper = wrapped_method.get("wrapper")
44
+ # Wrap operations
45
+ for method_name, endpoint in MILVUS_OPERATIONS:
84
46
  wrap_function_wrapper(
85
- wrap_package,
86
- wrap_object,
87
- wrapper(gen_ai_endpoint, version, environment, application_name,
88
- tracer, pricing_info, capture_message_content, metrics, disable_metrics),
47
+ "pymilvus",
48
+ f"MilvusClient.{method_name}",
49
+ general_wrap(
50
+ endpoint, version, environment, application_name, tracer,
51
+ pricing_info, capture_message_content, metrics, disable_metrics
52
+ ),
89
53
  )
90
54
 
91
-
92
- @staticmethod
93
55
  def _uninstrument(self, **kwargs):
94
56
  pass