Skip to content

Commit 9457282

Browse files
authored
Fixed doc strings of SPANDATA (#2084)
1 parent 716fa6b commit 9457282

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

sentry_sdk/consts.py

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,31 +51,43 @@ class INSTRUMENTER:
5151
OTEL = "otel"
5252

5353

54-
# See: https://develop.sentry.dev/sdk/performance/span-data-conventions/
5554
class SPANDATA:
56-
# An identifier for the database management system (DBMS) product being used.
57-
# See: https://github.com/open-telemetry/opentelemetry-python/blob/e00306206ea25cf8549eca289e39e0b6ba2fa560/opentelemetry-semantic-conventions/src/opentelemetry/semconv/trace/__init__.py#L58
55+
"""
56+
Additional information describing the type of the span.
57+
See: https://develop.sentry.dev/sdk/performance/span-data-conventions/
58+
"""
59+
5860
DB_SYSTEM = "db.system"
61+
"""
62+
An identifier for the database management system (DBMS) product being used.
63+
See: https://github.com/open-telemetry/opentelemetry-specification/blob/24de67b3827a4e3ab2515cd8ab62d5bcf837c586/specification/trace/semantic_conventions/database.md
64+
Example: postgresql
65+
"""
5966

60-
# A boolean indicating whether the requested data was found in the cache.
6167
CACHE_HIT = "cache.hit"
68+
"""
69+
A boolean indicating whether the requested data was found in the cache.
70+
Example: true
71+
"""
6272

63-
# The size of the requested data in bytes.
6473
CACHE_ITEM_SIZE = "cache.item_size"
6574
"""
66-
An identifier for the database management system (DBMS) product being used.
67-
See: https://github.com/open-telemetry/opentelemetry-python/blob/e00306206ea25cf8549eca289e39e0b6ba2fa560/opentelemetry-semantic-conventions/src/opentelemetry/semconv/trace/__init__.py#L58
75+
The size of the requested data in bytes.
76+
Example: 58
6877
"""
78+
6979
HTTP_QUERY = "http.query"
7080
"""
7181
The Query string present in the URL.
7282
Example: ?foo=bar&bar=baz
7383
"""
84+
7485
HTTP_FRAGMENT = "http.fragment"
7586
"""
7687
The Fragments present in the URL.
7788
Example: #foo=bar
7889
"""
90+
7991
HTTP_METHOD = "http.method"
8092
"""
8193
The HTTP method used.

0 commit comments

Comments
 (0)