forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconsts.py
More file actions
1489 lines (1149 loc) · 53.8 KB
/
Copy pathconsts.py
File metadata and controls
1489 lines (1149 loc) · 53.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import itertools
from enum import Enum
from typing import TYPE_CHECKING
# up top to prevent circular import due to integration import
# This is more or less an arbitrary large-ish value for now, so that we allow
# pretty long strings (like LLM prompts), but still have *some* upper limit
# until we verify that removing the trimming completely is safe.
DEFAULT_MAX_VALUE_LENGTH = 100_000
DEFAULT_MAX_STACK_FRAMES = 100
DEFAULT_ADD_FULL_STACK = False
# Also needs to be at the top to prevent circular import
class EndpointType(Enum):
"""
The type of an endpoint. This is an enum, rather than a constant, for historical reasons
(the old /store endpoint). The enum also preserve future compatibility, in case we ever
have a new endpoint.
"""
ENVELOPE = "envelope"
OTLP_TRACES = "integration/otlp/v1/traces"
class CompressionAlgo(Enum):
GZIP = "gzip"
BROTLI = "br"
if TYPE_CHECKING:
from typing import (
AbstractSet,
Any,
Callable,
Dict,
List,
Optional,
Sequence,
Tuple,
Type,
Union,
)
from typing_extensions import Literal, TypedDict
import sentry_sdk
from sentry_sdk._types import (
BreadcrumbProcessor,
ContinuousProfilerMode,
Event,
EventProcessor,
Hint,
IgnoreSpansConfig,
Log,
Metric,
ProfilerMode,
TracesSampler,
TransactionProcessor,
)
# Experiments are feature flags to enable and disable certain unstable SDK
# functionality. Changing them from the defaults (`None`) in production
# code is highly discouraged. They are not subject to any stability
# guarantees such as the ones from semantic versioning.
Experiments = TypedDict(
"Experiments",
{
"max_spans": Optional[int],
"max_flags": Optional[int],
"record_sql_params": Optional[bool],
"continuous_profiling_auto_start": Optional[bool],
"continuous_profiling_mode": Optional[ContinuousProfilerMode],
"otel_powered_performance": Optional[bool],
"transport_zlib_compression_level": Optional[int],
"transport_compression_level": Optional[int],
"transport_compression_algo": Optional[CompressionAlgo],
"transport_num_pools": Optional[int],
"transport_http2": Optional[bool],
"transport_async": Optional[bool],
"enable_logs": Optional[bool],
"before_send_log": Optional[Callable[[Log, Hint], Optional[Log]]],
"enable_metrics": Optional[bool],
"before_send_metric": Optional[Callable[[Metric, Hint], Optional[Metric]]],
"trace_lifecycle": Optional[Literal["static", "stream"]],
"ignore_spans": Optional[IgnoreSpansConfig],
"suppress_asgi_chained_exceptions": Optional[bool],
},
total=False,
)
DEFAULT_QUEUE_SIZE = 100
DEFAULT_MAX_BREADCRUMBS = 100
MATCH_ALL = r".*"
FALSE_VALUES = [
"false",
"no",
"off",
"n",
"0",
]
class SPANTEMPLATE(str, Enum):
DEFAULT = "default"
AI_AGENT = "ai_agent"
AI_TOOL = "ai_tool"
AI_CHAT = "ai_chat"
def __str__(self) -> str:
return self.value
class INSTRUMENTER:
SENTRY = "sentry"
OTEL = "otel"
class SPANNAME:
DB_COMMIT = "COMMIT"
DB_ROLLBACK = "ROLLBACK"
class SPANDATA:
"""
Additional information describing the type of the span.
See: https://develop.sentry.dev/sdk/performance/span-data-conventions/
"""
AI_CITATIONS = "ai.citations"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
References or sources cited by the AI model in its response.
Example: ["Smith et al. 2020", "Jones 2019"]
"""
AI_DOCUMENTS = "ai.documents"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Documents or content chunks used as context for the AI model.
Example: ["doc1.txt", "doc2.pdf"]
"""
AI_FINISH_REASON = "ai.finish_reason"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_RESPONSE_FINISH_REASONS instead.
The reason why the model stopped generating.
Example: "length"
"""
AI_FREQUENCY_PENALTY = "ai.frequency_penalty"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_FREQUENCY_PENALTY instead.
Used to reduce repetitiveness of generated tokens.
Example: 0.5
"""
AI_FUNCTION_CALL = "ai.function_call"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_RESPONSE_TOOL_CALLS instead.
For an AI model call, the function that was called. This is deprecated for OpenAI, and replaced by tool_calls
"""
AI_GENERATION_ID = "ai.generation_id"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_RESPONSE_ID instead.
Unique identifier for the completion.
Example: "gen_123abc"
"""
AI_INPUT_MESSAGES = "ai.input_messages"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_MESSAGES instead.
The input messages to an LLM call.
Example: [{"role": "user", "message": "hello"}]
"""
AI_LOGIT_BIAS = "ai.logit_bias"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
For an AI model call, the logit bias
"""
AI_METADATA = "ai.metadata"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Extra metadata passed to an AI pipeline step.
Example: {"executed_function": "add_integers"}
"""
AI_MODEL_ID = "ai.model_id"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_MODEL or GEN_AI_RESPONSE_MODEL instead.
The unique descriptor of the model being executed.
Example: gpt-4
"""
AI_PIPELINE_NAME = "ai.pipeline.name"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_PIPELINE_NAME instead.
Name of the AI pipeline or chain being executed.
Example: "qa-pipeline"
"""
AI_PREAMBLE = "ai.preamble"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
For an AI model call, the preamble parameter.
Preambles are a part of the prompt used to adjust the model's overall behavior and conversation style.
Example: "You are now a clown."
"""
AI_PRESENCE_PENALTY = "ai.presence_penalty"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_PRESENCE_PENALTY instead.
Used to reduce repetitiveness of generated tokens.
Example: 0.5
"""
AI_RAW_PROMPTING = "ai.raw_prompting"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Minimize pre-processing done to the prompt sent to the LLM.
Example: true
"""
AI_RESPONSE_FORMAT = "ai.response_format"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
For an AI model call, the format of the response
"""
AI_RESPONSES = "ai.responses"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_RESPONSE_TEXT instead.
The responses to an AI model call. Always as a list.
Example: ["hello", "world"]
"""
AI_SEARCH_QUERIES = "ai.search_queries"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Queries used to search for relevant context or documents.
Example: ["climate change effects", "renewable energy"]
"""
AI_SEARCH_REQUIRED = "ai.is_search_required"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Boolean indicating if the model needs to perform a search.
Example: true
"""
AI_SEARCH_RESULTS = "ai.search_results"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Results returned from search queries for context.
Example: ["Result 1", "Result 2"]
"""
AI_SEED = "ai.seed"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_SEED instead.
The seed, ideally models given the same seed and same other parameters will produce the exact same output.
Example: 123.45
"""
AI_STREAMING = "ai.streaming"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_RESPONSE_STREAMING instead.
Whether or not the AI model call's response was streamed back asynchronously
Example: true
"""
AI_TAGS = "ai.tags"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Tags that describe an AI pipeline step.
Example: {"executed_function": "add_integers"}
"""
AI_TEMPERATURE = "ai.temperature"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_TEMPERATURE instead.
For an AI model call, the temperature parameter. Temperature essentially means how random the output will be.
Example: 0.5
"""
AI_TEXTS = "ai.texts"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Raw text inputs provided to the model.
Example: ["What is machine learning?"]
"""
AI_TOP_K = "ai.top_k"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_TOP_K instead.
For an AI model call, the top_k parameter. Top_k essentially controls how random the output will be.
Example: 35
"""
AI_TOP_P = "ai.top_p"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_TOP_P instead.
For an AI model call, the top_p parameter. Top_p essentially controls how random the output will be.
Example: 0.5
"""
AI_TOOL_CALLS = "ai.tool_calls"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_RESPONSE_TOOL_CALLS instead.
For an AI model call, the function that was called. This is deprecated for OpenAI, and replaced by tool_calls
"""
AI_TOOLS = "ai.tools"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_REQUEST_AVAILABLE_TOOLS instead.
For an AI model call, the functions that are available
"""
AI_WARNINGS = "ai.warnings"
"""
.. deprecated::
This attribute is deprecated. Use GEN_AI_* attributes instead.
Warning messages generated during model execution.
Example: ["Token limit exceeded"]
"""
CACHE_HIT = "cache.hit"
"""
A boolean indicating whether the requested data was found in the cache.
Example: true
"""
CACHE_ITEM_SIZE = "cache.item_size"
"""
The size of the requested data in bytes.
Example: 58
"""
CACHE_KEY = "cache.key"
"""
The key of the requested data.
Example: template.cache.some_item.867da7e2af8e6b2f3aa7213a4080edb3
"""
CODE_FILEPATH = "code.filepath"
"""
The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path).
Example: "/app/myapplication/http/handler/server.py"
"""
CODE_FUNCTION = "code.function"
"""
The method or function name, or equivalent (usually rightmost part of the code unit's name).
Example: "server_request"
"""
CODE_LINENO = "code.lineno"
"""
The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
Example: 42
"""
CODE_NAMESPACE = "code.namespace"
"""
The "namespace" within which `code.function` is defined. Usually the qualified class or module name, such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit.
Example: "http.handler"
"""
DB_MONGODB_COLLECTION = "db.mongodb.collection"
"""
The MongoDB collection being accessed within the database.
See: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/mongodb.md#attributes
Example: public.users; customers
"""
DB_NAME = "db.name"
"""
The name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails).
Example: myDatabase
"""
DB_OPERATION = "db.operation"
"""
The name of the operation being executed, e.g. the MongoDB command name such as findAndModify, or the SQL keyword.
See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md
Example: findAndModify, HMSET, SELECT
"""
DB_SYSTEM = "db.system"
"""
An identifier for the database management system (DBMS) product being used.
See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md
Example: postgresql
"""
DB_USER = "db.user"
"""
The name of the database user used for connecting to the database.
See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md
Example: my_user
"""
GEN_AI_AGENT_NAME = "gen_ai.agent.name"
"""
The name of the agent being used.
Example: "ResearchAssistant"
"""
GEN_AI_CONVERSATION_ID = "gen_ai.conversation.id"
"""
The unique identifier for the conversation/thread with the AI model.
Example: "conv_abc123"
"""
GEN_AI_CHOICE = "gen_ai.choice"
"""
The model's response message.
Example: "The weather in Paris is rainy and overcast, with temperatures around 57°F"
"""
GEN_AI_EMBEDDINGS_INPUT = "gen_ai.embeddings.input"
"""
The input to the embeddings operation.
Example: "Hello!"
"""
GEN_AI_OPERATION_NAME = "gen_ai.operation.name"
"""
The name of the operation being performed.
Example: "chat"
"""
GEN_AI_PIPELINE_NAME = "gen_ai.pipeline.name"
"""
Name of the AI pipeline or chain being executed.
Example: "qa-pipeline"
"""
GEN_AI_RESPONSE_FINISH_REASONS = "gen_ai.response.finish_reasons"
"""
The reason why the model stopped generating.
Example: "COMPLETE"
"""
GEN_AI_RESPONSE_ID = "gen_ai.response.id"
"""
Unique identifier for the completion.
Example: "gen_123abc"
"""
GEN_AI_RESPONSE_MODEL = "gen_ai.response.model"
"""
Exact model identifier used to generate the response
Example: gpt-4o-mini-2024-07-18
"""
GEN_AI_RESPONSE_STREAMING = "gen_ai.response.streaming"
"""
Whether or not the AI model call's response was streamed back asynchronously
Example: true
"""
GEN_AI_RESPONSE_TEXT = "gen_ai.response.text"
"""
The model's response text messages.
Example: ["The weather in Paris is rainy and overcast, with temperatures around 57°F", "The weather in London is sunny and warm, with temperatures around 65°F"]
"""
GEN_AI_RESPONSE_TIME_TO_FIRST_TOKEN = "gen_ai.response.time_to_first_token"
"""
The time it took to receive the first token from the model.
Example: 0.1
"""
GEN_AI_RESPONSE_TOOL_CALLS = "gen_ai.response.tool_calls"
"""
The tool calls in the model's response.
Example: [{"name": "get_weather", "arguments": {"location": "Paris"}}]
"""
GEN_AI_REQUEST_AVAILABLE_TOOLS = "gen_ai.request.available_tools"
"""
The available tools for the model.
Example: [{"name": "get_weather", "description": "Get the weather for a given location"}, {"name": "get_news", "description": "Get the news for a given topic"}]
"""
GEN_AI_REQUEST_FREQUENCY_PENALTY = "gen_ai.request.frequency_penalty"
"""
The frequency penalty parameter used to reduce repetitiveness of generated tokens.
Example: 0.1
"""
GEN_AI_REQUEST_MAX_TOKENS = "gen_ai.request.max_tokens"
"""
The maximum number of tokens to generate in the response.
Example: 2048
"""
GEN_AI_SYSTEM_INSTRUCTIONS = "gen_ai.system_instructions"
"""
The system instructions passed to the model.
Example: [{"type": "text", "text": "You are a helpful assistant."},{"type": "text", "text": "Be concise and clear."}]
"""
GEN_AI_REQUEST_MESSAGES = "gen_ai.request.messages"
"""
The messages passed to the model. The "content" can be a string or an array of objects.
Example: [{role: "system", "content: "Generate a random number."}, {"role": "user", "content": [{"text": "Generate a random number between 0 and 10.", "type": "text"}]}]
"""
GEN_AI_REQUEST_MODEL = "gen_ai.request.model"
"""
The model identifier being used for the request.
Example: "gpt-4-turbo"
"""
GEN_AI_REQUEST_PRESENCE_PENALTY = "gen_ai.request.presence_penalty"
"""
The presence penalty parameter used to reduce repetitiveness of generated tokens.
Example: 0.1
"""
GEN_AI_REQUEST_SEED = "gen_ai.request.seed"
"""
The seed, ideally models given the same seed and same other parameters will produce the exact same output.
Example: "1234567890"
"""
GEN_AI_REQUEST_TEMPERATURE = "gen_ai.request.temperature"
"""
The temperature parameter used to control randomness in the output.
Example: 0.7
"""
GEN_AI_REQUEST_TOP_K = "gen_ai.request.top_k"
"""
Limits the model to only consider the K most likely next tokens, where K is an integer (e.g., top_k=20 means only the 20 highest probability tokens are considered).
Example: 35
"""
GEN_AI_REQUEST_TOP_P = "gen_ai.request.top_p"
"""
The top_p parameter used to control diversity via nucleus sampling.
Example: 1.0
"""
GEN_AI_SYSTEM = "gen_ai.system"
"""
The name of the AI system being used.
Example: "openai"
"""
GEN_AI_TOOL_DESCRIPTION = "gen_ai.tool.description"
"""
The description of the tool being used.
Example: "Searches the web for current information about a topic"
"""
GEN_AI_TOOL_INPUT = "gen_ai.tool.input"
"""
The input of the tool being used.
Example: {"location": "Paris"}
"""
GEN_AI_TOOL_NAME = "gen_ai.tool.name"
"""
The name of the tool being used.
Example: "web_search"
"""
GEN_AI_TOOL_OUTPUT = "gen_ai.tool.output"
"""
The output of the tool being used.
Example: "rainy, 57°F"
"""
GEN_AI_USAGE_INPUT_TOKENS = "gen_ai.usage.input_tokens"
"""
The number of tokens in the input.
Example: 150
"""
GEN_AI_USAGE_INPUT_TOKENS_CACHED = "gen_ai.usage.input_tokens.cached"
"""
The number of cached tokens in the input.
Example: 50
"""
GEN_AI_USAGE_INPUT_TOKENS_CACHE_WRITE = "gen_ai.usage.input_tokens.cache_write"
"""
The number of tokens written to the cache when processing the AI input (prompt).
Example: 100
"""
GEN_AI_USAGE_OUTPUT_TOKENS = "gen_ai.usage.output_tokens"
"""
The number of tokens in the output.
Example: 250
"""
GEN_AI_USAGE_OUTPUT_TOKENS_REASONING = "gen_ai.usage.output_tokens.reasoning"
"""
The number of tokens used for reasoning in the output.
Example: 75
"""
GEN_AI_USAGE_TOTAL_TOKENS = "gen_ai.usage.total_tokens"
"""
The total number of tokens used (input + output).
Example: 400
"""
GEN_AI_USER_MESSAGE = "gen_ai.user.message"
"""
The user message passed to the model.
Example: "What's the weather in Paris?"
"""
HTTP_FRAGMENT = "http.fragment"
"""
The Fragments present in the URL.
Example: #foo=bar
"""
HTTP_METHOD = "http.method"
"""
The HTTP method used.
Example: GET
"""
HTTP_QUERY = "http.query"
"""
The Query string present in the URL.
Example: ?foo=bar&bar=baz
"""
HTTP_STATUS_CODE = "http.response.status_code"
"""
The HTTP status code as an integer.
Example: 418
"""
MESSAGING_DESTINATION_NAME = "messaging.destination.name"
"""
The destination name where the message is being consumed from,
e.g. the queue name or topic.
"""
MESSAGING_MESSAGE_ID = "messaging.message.id"
"""
The message's identifier.
"""
MESSAGING_MESSAGE_RECEIVE_LATENCY = "messaging.message.receive.latency"
"""
The latency between when the task was enqueued and when it was started to be processed.
"""
MESSAGING_MESSAGE_RETRY_COUNT = "messaging.message.retry.count"
"""
Number of retries/attempts to process a message.
"""
MESSAGING_SYSTEM = "messaging.system"
"""
The messaging system's name, e.g. `kafka`, `aws_sqs`
"""
NETWORK_PEER_ADDRESS = "network.peer.address"
"""
Peer address of the network connection - IP address or Unix domain socket name.
Example: 10.1.2.80, /tmp/my.sock, localhost
"""
NETWORK_PEER_PORT = "network.peer.port"
"""
Peer port number of the network connection.
Example: 6379
"""
NETWORK_TRANSPORT = "network.transport"
"""
The transport protocol used for the network connection.
Example: "tcp", "udp", "unix"
"""
PROFILER_ID = "profiler_id"
"""
Label identifying the profiler id that the span occurred in. This should be a string.
Example: "5249fbada8d5416482c2f6e47e337372"
"""
SERVER_ADDRESS = "server.address"
"""
Name of the database host.
Example: example.com
"""
SERVER_PORT = "server.port"
"""
Logical server port number
Example: 80; 8080; 443
"""
SERVER_SOCKET_ADDRESS = "server.socket.address"
"""
Physical server IP address or Unix socket address.
Example: 10.5.3.2
"""
SERVER_SOCKET_PORT = "server.socket.port"
"""
Physical server port.
Recommended: If different than server.port.
Example: 16456
"""
THREAD_ID = "thread.id"
"""
Identifier of a thread from where the span originated. This should be a string.
Example: "7972576320"
"""
THREAD_NAME = "thread.name"
"""
Label identifying a thread from where the span originated. This should be a string.
Example: "MainThread"
"""
MCP_TOOL_NAME = "mcp.tool.name"
"""
The name of the MCP tool being called.
Example: "get_weather"
"""
MCP_PROMPT_NAME = "mcp.prompt.name"
"""
The name of the MCP prompt being retrieved.
Example: "code_review"
"""
MCP_RESOURCE_URI = "mcp.resource.uri"
"""
The URI of the MCP resource being accessed.
Example: "file:///path/to/resource"
"""
MCP_METHOD_NAME = "mcp.method.name"
"""
The MCP protocol method name being called.
Example: "tools/call", "prompts/get", "resources/read"
"""
MCP_REQUEST_ID = "mcp.request.id"
"""
The unique identifier for the MCP request.
Example: "req_123abc"
"""
MCP_TOOL_RESULT_CONTENT = "mcp.tool.result.content"
"""
The result/output content from an MCP tool execution.
Example: "The weather is sunny"
"""
MCP_TOOL_RESULT_CONTENT_COUNT = "mcp.tool.result.content_count"
"""
The number of items/keys in the MCP tool result.
Example: 5
"""
MCP_TOOL_RESULT_IS_ERROR = "mcp.tool.result.is_error"
"""
Whether the MCP tool execution resulted in an error.
Example: True
"""
MCP_PROMPT_RESULT_MESSAGE_CONTENT = "mcp.prompt.result.message_content"
"""
The message content from an MCP prompt retrieval.
Example: "Review the following code..."
"""
MCP_PROMPT_RESULT_MESSAGE_ROLE = "mcp.prompt.result.message_role"
"""
The role of the message in an MCP prompt retrieval (only set for single-message prompts).
Example: "user", "assistant", "system"
"""
MCP_PROMPT_RESULT_MESSAGE_COUNT = "mcp.prompt.result.message_count"
"""
The number of messages in an MCP prompt result.
Example: 1, 3
"""
MCP_RESOURCE_PROTOCOL = "mcp.resource.protocol"
"""
The protocol/scheme of the MCP resource URI.
Example: "file", "http", "https"
"""
MCP_TRANSPORT = "mcp.transport"
"""
The transport method used for MCP communication.
Example: "http", "sse", "stdio"
"""
MCP_SESSION_ID = "mcp.session.id"
"""
The session identifier for the MCP connection.
Example: "a1b2c3d4e5f6"
"""
class SPANSTATUS:
"""
The status of a Sentry span.
See: https://develop.sentry.dev/sdk/event-payloads/contexts/#trace-context
"""
ABORTED = "aborted"
ALREADY_EXISTS = "already_exists"
CANCELLED = "cancelled"
DATA_LOSS = "data_loss"
DEADLINE_EXCEEDED = "deadline_exceeded"
FAILED_PRECONDITION = "failed_precondition"
INTERNAL_ERROR = "internal_error"
INVALID_ARGUMENT = "invalid_argument"
NOT_FOUND = "not_found"
OK = "ok"
OUT_OF_RANGE = "out_of_range"
PERMISSION_DENIED = "permission_denied"
RESOURCE_EXHAUSTED = "resource_exhausted"
UNAUTHENTICATED = "unauthenticated"
UNAVAILABLE = "unavailable"
UNIMPLEMENTED = "unimplemented"
UNKNOWN_ERROR = "unknown_error"
class OP:
ANTHROPIC_MESSAGES_CREATE = "ai.messages.create.anthropic"
CACHE_GET = "cache.get"
CACHE_PUT = "cache.put"
COHERE_CHAT_COMPLETIONS_CREATE = "ai.chat_completions.create.cohere"
COHERE_EMBEDDINGS_CREATE = "ai.embeddings.create.cohere"
DB = "db"
DB_REDIS = "db.redis"
EVENT_DJANGO = "event.django"
FUNCTION = "function"
FUNCTION_AWS = "function.aws"
FUNCTION_GCP = "function.gcp"
GEN_AI_CHAT = "gen_ai.chat"
GEN_AI_CREATE_AGENT = "gen_ai.create_agent"
GEN_AI_EMBEDDINGS = "gen_ai.embeddings"
GEN_AI_EXECUTE_TOOL = "gen_ai.execute_tool"
GEN_AI_TEXT_COMPLETION = "gen_ai.text_completion"
GEN_AI_HANDOFF = "gen_ai.handoff"
GEN_AI_INVOKE_AGENT = "gen_ai.invoke_agent"
GEN_AI_RESPONSES = "gen_ai.responses"
GRAPHQL_EXECUTE = "graphql.execute"
GRAPHQL_MUTATION = "graphql.mutation"
GRAPHQL_PARSE = "graphql.parse"
GRAPHQL_RESOLVE = "graphql.resolve"
GRAPHQL_SUBSCRIPTION = "graphql.subscription"
GRAPHQL_QUERY = "graphql.query"
GRAPHQL_VALIDATE = "graphql.validate"
GRPC_CLIENT = "grpc.client"
GRPC_SERVER = "grpc.server"
HTTP_CLIENT = "http.client"
HTTP_CLIENT_STREAM = "http.client.stream"
HTTP_SERVER = "http.server"
MIDDLEWARE_DJANGO = "middleware.django"
MIDDLEWARE_LITESTAR = "middleware.litestar"
MIDDLEWARE_LITESTAR_RECEIVE = "middleware.litestar.receive"
MIDDLEWARE_LITESTAR_SEND = "middleware.litestar.send"
MIDDLEWARE_STARLETTE = "middleware.starlette"
MIDDLEWARE_STARLETTE_RECEIVE = "middleware.starlette.receive"
MIDDLEWARE_STARLETTE_SEND = "middleware.starlette.send"
MIDDLEWARE_STARLITE = "middleware.starlite"
MIDDLEWARE_STARLITE_RECEIVE = "middleware.starlite.receive"
MIDDLEWARE_STARLITE_SEND = "middleware.starlite.send"
HUGGINGFACE_HUB_CHAT_COMPLETIONS_CREATE = (
"ai.chat_completions.create.huggingface_hub"
)
QUEUE_PROCESS = "queue.process"
QUEUE_PUBLISH = "queue.publish"
QUEUE_SUBMIT_ARQ = "queue.submit.arq"
QUEUE_TASK_ARQ = "queue.task.arq"
QUEUE_SUBMIT_CELERY = "queue.submit.celery"
QUEUE_TASK_CELERY = "queue.task.celery"
QUEUE_TASK_RQ = "queue.task.rq"
QUEUE_SUBMIT_HUEY = "queue.submit.huey"
QUEUE_TASK_HUEY = "queue.task.huey"
QUEUE_SUBMIT_RAY = "queue.submit.ray"
QUEUE_TASK_RAY = "queue.task.ray"
QUEUE_TASK_DRAMATIQ = "queue.task.dramatiq"
QUEUE_SUBMIT_DJANGO = "queue.submit.django"
SUBPROCESS = "subprocess"
SUBPROCESS_WAIT = "subprocess.wait"
SUBPROCESS_COMMUNICATE = "subprocess.communicate"
TEMPLATE_RENDER = "template.render"
VIEW_RENDER = "view.render"
VIEW_RESPONSE_RENDER = "view.response.render"
WEBSOCKET_SERVER = "websocket.server"
SOCKET_CONNECTION = "socket.connection"
SOCKET_DNS = "socket.dns"
MCP_SERVER = "mcp.server"
# This type exists to trick mypy and PyCharm into thinking `init` and `Client`
# take these arguments (even though they take opaque **kwargs)
class ClientConstructor:
def __init__(
self,
dsn: "Optional[str]" = None,
*,
max_breadcrumbs: int = DEFAULT_MAX_BREADCRUMBS,
release: "Optional[str]" = None,
environment: "Optional[str]" = None,
server_name: "Optional[str]" = None,
shutdown_timeout: float = 2,
integrations: "Sequence[sentry_sdk.integrations.Integration]" = [], # noqa: B006
in_app_include: "List[str]" = [], # noqa: B006
in_app_exclude: "List[str]" = [], # noqa: B006
default_integrations: bool = True,
dist: "Optional[str]" = None,
transport: "Optional[Union[sentry_sdk.transport.Transport, Type[sentry_sdk.transport.Transport], Callable[[Event], None]]]" = None,
transport_queue_size: int = DEFAULT_QUEUE_SIZE,
sample_rate: float = 1.0,
send_default_pii: "Optional[bool]" = None,
http_proxy: "Optional[str]" = None,
https_proxy: "Optional[str]" = None,
ignore_errors: "Sequence[Union[type, str]]" = [], # noqa: B006
max_request_body_size: str = "medium",
socket_options: "Optional[List[Tuple[int, int, int | bytes]]]" = None,
keep_alive: "Optional[bool]" = None,
before_send: "Optional[EventProcessor]" = None,