forked from open-telemetry/weaver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexpected-attribute-catalog.json
More file actions
1418 lines (1418 loc) · 49.6 KB
/
expected-attribute-catalog.json
File metadata and controls
1418 lines (1418 loc) · 49.6 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
[
{
"name": "error.type",
"type": {
"members": [
{
"id": "other",
"value": "_OTHER",
"brief": "A fallback error value to be used when the instrumentation doesn't define a custom value.\n",
"stability": "stable"
}
]
},
"brief": "Describes a class of error the operation ended with.\n",
"examples": [
"amqp:decode-error",
"KAFKA_STORAGE_ERROR",
"channel-error"
],
"requirement_level": {
"conditionally_required": "If and only if the messaging operation has failed."
},
"note": "The `error.type` SHOULD be predictable and SHOULD have low cardinality.\nInstrumentations SHOULD document the list of errors they report.\n\nThe cardinality of `error.type` within one instrumentation library SHOULD be low.\nTelemetry consumers that aggregate data from multiple instrumentation libraries and applications\nshould be prepared for `error.type` to have high cardinality at query time when no\nadditional filters are applied.\n\nIf the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.\n\nIf a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),\nit's RECOMMENDED to:\n\n* Use a domain-specific attribute\n* Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not\n\nAnd something more.",
"stability": "stable"
},
{
"name": "error.type",
"type": {
"members": [
{
"id": "other",
"value": "_OTHER",
"brief": "A fallback error value to be used when the instrumentation doesn't define a custom value.\n",
"stability": "stable"
}
]
},
"brief": "Describes a class of error the operation ended with.\n",
"examples": [
"timeout",
"java.net.UnknownHostException",
"server_certificate_invalid",
"500"
],
"requirement_level": "recommended",
"note": "The `error.type` SHOULD be predictable and SHOULD have low cardinality.\nInstrumentations SHOULD document the list of errors they report.\n\nThe cardinality of `error.type` within one instrumentation library SHOULD be low.\nTelemetry consumers that aggregate data from multiple instrumentation libraries and applications\nshould be prepared for `error.type` to have high cardinality at query time when no\nadditional filters are applied.\n\nIf the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.\n\nIf a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),\nit's RECOMMENDED to:\n\n* Use a domain-specific attribute\n* Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not\n\nAnd something more.",
"stability": "stable"
},
{
"name": "error.type",
"type": {
"members": [
{
"id": "other",
"value": "_OTHER",
"brief": "A fallback error value to be used when the instrumentation doesn't define a custom value.\n",
"stability": "stable"
}
]
},
"brief": "Describes a class of error the operation ended with.\n",
"examples": [
"timeout",
"java.net.UnknownHostException",
"server_certificate_invalid",
"500"
],
"requirement_level": {
"conditionally_required": "If request has ended with an error."
},
"note": "If the request fails with an error before response status code was sent or received,\n`error.type` SHOULD be set to exception type (its fully-qualified class name, if applicable)\nor a component-specific low cardinality error identifier.\n\nIf response status code was sent or received and status indicates an error according to [HTTP span status definition](/docs/http/http-spans.md),\n`error.type` SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.\n\nThe `error.type` value SHOULD be predictable and SHOULD have low cardinality.\nInstrumentations SHOULD document the list of errors they report.\n\nThe cardinality of `error.type` within one instrumentation library SHOULD be low, but\ntelemetry consumers that aggregate data from multiple instrumentation libraries and applications\nshould be prepared for `error.type` to have high cardinality at query time, when no\nadditional filters are applied.\n\nIf the request has completed successfully, instrumentations SHOULD NOT set `error.type`.\n",
"stability": "stable"
},
{
"name": "http.request.body.size",
"type": "int",
"brief": "The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.\n",
"examples": 3495,
"requirement_level": "recommended",
"stability": "development"
},
{
"name": "http.request.header",
"type": "template[string[]]",
"brief": "HTTP request headers, `<key>` being the normalized HTTP Header name (lowercase), the value being the header values.\n",
"examples": [
[
"application/json"
],
[
"1.2.3.4",
"1.2.3.5"
]
],
"requirement_level": "recommended",
"note": "Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information.\nThe `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended.\nThe attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers.\n",
"stability": "stable"
},
{
"name": "http.request.method",
"type": {
"members": [
{
"id": "connect",
"value": "CONNECT",
"brief": "CONNECT method.",
"stability": "stable"
},
{
"id": "delete",
"value": "DELETE",
"brief": "DELETE method.",
"stability": "stable"
},
{
"id": "get",
"value": "GET",
"brief": "GET method.",
"stability": "stable"
},
{
"id": "head",
"value": "HEAD",
"brief": "HEAD method.",
"stability": "stable"
},
{
"id": "options",
"value": "OPTIONS",
"brief": "OPTIONS method.",
"stability": "stable"
},
{
"id": "patch",
"value": "PATCH",
"brief": "PATCH method.",
"stability": "stable"
},
{
"id": "post",
"value": "POST",
"brief": "POST method.",
"stability": "stable"
},
{
"id": "put",
"value": "PUT",
"brief": "PUT method.",
"stability": "stable"
},
{
"id": "trace",
"value": "TRACE",
"brief": "TRACE method.",
"stability": "stable"
},
{
"id": "other",
"value": "_OTHER",
"brief": "Any HTTP method that the instrumentation has no prior knowledge of.",
"stability": "stable"
}
]
},
"brief": "HTTP request method.",
"examples": [
"GET",
"POST",
"HEAD"
],
"requirement_level": "required",
"note": "HTTP request method value SHOULD be \"known\" to the instrumentation.\nBy default, this convention defines \"known\" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)\nand the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).\n\nIf the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.\n\nIf the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override\nthe list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named\nOTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods\n(this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).\n\nHTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly.\nInstrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent.\nTracing instrumentations that do so, MUST also set `http.request.method_original` to the original value.\n",
"stability": "stable"
},
{
"name": "http.request.method",
"type": {
"members": [
{
"id": "connect",
"value": "CONNECT",
"brief": "CONNECT method.",
"stability": "stable"
},
{
"id": "delete",
"value": "DELETE",
"brief": "DELETE method.",
"stability": "stable"
},
{
"id": "get",
"value": "GET",
"brief": "GET method.",
"stability": "stable"
},
{
"id": "head",
"value": "HEAD",
"brief": "HEAD method.",
"stability": "stable"
},
{
"id": "options",
"value": "OPTIONS",
"brief": "OPTIONS method.",
"stability": "stable"
},
{
"id": "patch",
"value": "PATCH",
"brief": "PATCH method.",
"stability": "stable"
},
{
"id": "post",
"value": "POST",
"brief": "POST method.",
"stability": "stable"
},
{
"id": "put",
"value": "PUT",
"brief": "PUT method.",
"stability": "stable"
},
{
"id": "trace",
"value": "TRACE",
"brief": "TRACE method.",
"stability": "stable"
},
{
"id": "other",
"value": "_OTHER",
"brief": "Any HTTP method that the instrumentation has no prior knowledge of.",
"stability": "stable"
}
]
},
"brief": "HTTP request method.",
"examples": [
"GET",
"POST",
"HEAD"
],
"requirement_level": "recommended",
"note": "HTTP request method value SHOULD be \"known\" to the instrumentation.\nBy default, this convention defines \"known\" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)\nand the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).\n\nIf the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.\n\nIf the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override\nthe list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named\nOTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods\n(this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).\n\nHTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly.\nInstrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent.\nTracing instrumentations that do so, MUST also set `http.request.method_original` to the original value.\n",
"stability": "stable"
},
{
"name": "http.request.method_original",
"type": "string",
"brief": "Original HTTP method sent by the client in the request line.",
"examples": [
"GeT",
"ACL",
"foo"
],
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "http.request.resend_count",
"type": "int",
"brief": "The ordinal number of request resending attempt (for any reason, including redirects).\n",
"examples": 3,
"requirement_level": "recommended",
"note": "The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other).\n",
"stability": "stable"
},
{
"name": "http.response.body.size",
"type": "int",
"brief": "The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.\n",
"examples": 3495,
"requirement_level": "recommended",
"stability": "development"
},
{
"name": "http.response.header",
"type": "template[string[]]",
"brief": "HTTP response headers, `<key>` being the normalized HTTP Header name (lowercase), the value being the header values.\n",
"examples": [
[
"application/json"
],
[
"abc",
"def"
]
],
"requirement_level": "recommended",
"note": "Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information.\nUsers MAY explicitly configure instrumentations to capture them even though it is not recommended.\nThe attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers.\n",
"stability": "stable"
},
{
"name": "http.response.status_code",
"type": "int",
"brief": "[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).",
"examples": [
200
],
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "http.response.status_code",
"type": "int",
"brief": "[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).",
"examples": [
200
],
"requirement_level": {
"conditionally_required": "If and only if one was received/sent."
},
"stability": "stable"
},
{
"name": "http.route",
"type": "string",
"brief": "The matched route, that is, the path template in the format used by the respective server framework.\n",
"examples": [
"/users/:userID?",
"{controller}/{action}/{id?}"
],
"requirement_level": "recommended",
"note": "MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it.\nSHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one.",
"stability": "stable"
},
{
"name": "http.route",
"type": "string",
"brief": "The matched route, that is, the path template in the format used by the respective server framework.\n",
"examples": [
"/users/:userID?",
"{controller}/{action}/{id?}"
],
"requirement_level": {
"conditionally_required": "If and only if it's available"
},
"note": "MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it.\nSHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one.",
"stability": "stable"
},
{
"name": "messaging.batch.message_count",
"type": "int",
"brief": "The number of messages sent, received, or processed in the scope of the batching operation.",
"examples": [
0,
1,
2
],
"requirement_level": "recommended",
"note": "Instrumentations SHOULD NOT set `messaging.batch.message_count` on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use `messaging.batch.message_count` for batching APIs and SHOULD NOT use it for single-message APIs.\n",
"stability": "stable"
},
{
"name": "messaging.client_id",
"type": "string",
"brief": "A unique identifier for the client that consumes or produces a message.\n",
"examples": [
"client-5",
"myhost@8742@s8083jm"
],
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.destination.anonymous",
"type": "boolean",
"brief": "A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.destination.name",
"type": "string",
"brief": "The message destination name",
"examples": [
"MyQueue",
"MyTopic"
],
"requirement_level": "recommended",
"note": "Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If\nthe broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.\n",
"stability": "stable"
},
{
"name": "messaging.destination.name",
"type": "string",
"brief": "The message destination name",
"examples": [
"MyQueue",
"MyTopic"
],
"requirement_level": {
"conditionally_required": "if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated."
},
"note": "Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If\nthe broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.\n",
"stability": "stable"
},
{
"name": "messaging.destination.template",
"type": "string",
"brief": "Low cardinality representation of the messaging destination name",
"examples": [
"/customers/{customerId}"
],
"requirement_level": "recommended",
"note": "Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.\n",
"stability": "stable"
},
{
"name": "messaging.destination.template",
"type": "string",
"brief": "Low cardinality representation of the messaging destination name",
"examples": [
"/customers/{customerId}"
],
"requirement_level": {
"conditionally_required": "if available."
},
"note": "Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.\n",
"stability": "stable"
},
{
"name": "messaging.destination.temporary",
"type": "boolean",
"brief": "A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.destination_publish.anonymous",
"type": "boolean",
"brief": "A boolean that is true if the publish message destination is anonymous (could be unnamed or have auto-generated name).",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.destination_publish.name",
"type": "string",
"brief": "The name of the original destination the message was published to",
"examples": [
"MyQueue",
"MyTopic"
],
"requirement_level": "recommended",
"note": "The name SHOULD uniquely identify a specific queue, topic, or other entity within the broker. If\nthe broker doesn't have such notion, the original destination name SHOULD uniquely identify the broker.\n",
"stability": "stable"
},
{
"name": "messaging.gcp_pubsub.message.ordering_key",
"type": "string",
"brief": "The ordering key for a given message. If the attribute is not present, the message does not have an ordering key.\n",
"examples": "ordering_key",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.kafka.consumer.group",
"type": "string",
"brief": "Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers.\n",
"examples": "my-group",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.kafka.destination.partition",
"type": "int",
"brief": "Partition the message is sent to.\n",
"examples": 2,
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.kafka.message.key",
"type": "string",
"brief": "Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from `messaging.message.id` in that they're not unique. If the key is `null`, the attribute MUST NOT be set.\n",
"examples": "myKey",
"requirement_level": "recommended",
"note": "If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value.\n",
"stability": "stable"
},
{
"name": "messaging.kafka.message.offset",
"type": "int",
"brief": "The offset of a record in the corresponding Kafka partition.\n",
"examples": 42,
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.kafka.message.tombstone",
"type": "boolean",
"brief": "A boolean that is true if the message is a tombstone.",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.message.body.size",
"type": "int",
"brief": "The size of the message body in bytes.\n",
"examples": 1439,
"requirement_level": "recommended",
"note": "This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed\nbody size should be used.\n",
"stability": "stable"
},
{
"name": "messaging.message.conversation_id",
"type": "string",
"brief": "The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called \"Correlation ID\".\n",
"examples": "MyConversationId",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.message.envelope.size",
"type": "int",
"brief": "The size of the message body and metadata in bytes.\n",
"examples": 2738,
"requirement_level": "recommended",
"note": "This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed\nsize should be used.\n",
"stability": "stable"
},
{
"name": "messaging.message.id",
"type": "string",
"brief": "A value used by the messaging system as an identifier for the message, represented as a string.",
"examples": "452a7c7c7c7048c2f887f61572b18fc2",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.operation",
"type": {
"members": [
{
"id": "publish",
"value": "publish",
"brief": "One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the \"Publish\" span can be used as the creation context and no \"Create\" span needs to be created.\n",
"stability": "stable"
},
{
"id": "create",
"value": "create",
"brief": "A message is created. \"Create\" spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios.\n",
"stability": "stable"
},
{
"id": "receive",
"value": "receive",
"brief": "One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages.\n",
"stability": "stable"
},
{
"id": "deliver",
"value": "deliver",
"brief": "One or more messages are passed to a consumer. This operation refers to push-based scenarios, where consumer register callbacks which get called by messaging SDKs.\n",
"stability": "stable"
}
]
},
"brief": "A string identifying the kind of messaging operation.\n",
"requirement_level": "recommended",
"note": "If a custom value is used, it MUST be of low cardinality.",
"stability": "stable"
},
{
"name": "messaging.rabbitmq.destination.routing_key",
"type": "string",
"brief": "RabbitMQ message routing key.\n",
"examples": "myKey",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.client_group",
"type": "string",
"brief": "Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind.\n",
"examples": "myConsumerGroup",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.consumption_model",
"type": {
"members": [
{
"id": "clustering",
"value": "clustering",
"brief": "Clustering consumption model",
"stability": "stable"
},
{
"id": "broadcasting",
"value": "broadcasting",
"brief": "Broadcasting consumption model",
"stability": "stable"
}
]
},
"brief": "Model of message consumption. This only applies to consumer spans.\n",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.message.delay_time_level",
"type": "int",
"brief": "The delay time level for delay message, which determines the message delay time.\n",
"examples": 3,
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.message.delivery_timestamp",
"type": "int",
"brief": "The timestamp in milliseconds that the delay message is expected to be delivered to consumer.\n",
"examples": 1665987217045,
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.message.group",
"type": "string",
"brief": "It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.\n",
"examples": "myMessageGroup",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.message.keys",
"type": "string[]",
"brief": "Key(s) of message, another way to mark message besides message id.\n",
"examples": [
[
"keyA"
],
[
"keyB"
]
],
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.message.tag",
"type": "string",
"brief": "The secondary classifier of message besides topic.\n",
"examples": "tagA",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.message.type",
"type": {
"members": [
{
"id": "normal",
"value": "normal",
"brief": "Normal message",
"stability": "stable"
},
{
"id": "fifo",
"value": "fifo",
"brief": "FIFO message",
"stability": "stable"
},
{
"id": "delay",
"value": "delay",
"brief": "Delay message",
"stability": "stable"
},
{
"id": "transaction",
"value": "transaction",
"brief": "Transaction message",
"stability": "stable"
}
]
},
"brief": "Type of message.\n",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.rocketmq.namespace",
"type": "string",
"brief": "Namespace of RocketMQ resources, resources in different namespaces are individual.\n",
"examples": "myNamespace",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "messaging.system",
"type": {
"members": [
{
"id": "activemq",
"value": "activemq",
"brief": "Apache ActiveMQ",
"stability": "stable"
},
{
"id": "aws_sqs",
"value": "aws_sqs",
"brief": "Amazon Simple Queue Service (SQS)",
"stability": "stable"
},
{
"id": "azure_eventgrid",
"value": "azure_eventgrid",
"brief": "Azure Event Grid",
"stability": "stable"
},
{
"id": "azure_eventhubs",
"value": "azure_eventhubs",
"brief": "Azure Event Hubs",
"stability": "stable"
},
{
"id": "azure_servicebus",
"value": "azure_servicebus",
"brief": "Azure Service Bus",
"stability": "stable"
},
{
"id": "gcp_pubsub",
"value": "gcp_pubsub",
"brief": "Google Cloud Pub/Sub",
"stability": "stable"
},
{
"id": "jms",
"value": "jms",
"brief": "Java Message Service",
"stability": "stable"
},
{
"id": "kafka",
"value": "kafka",
"brief": "Apache Kafka",
"stability": "stable"
},
{
"id": "rabbitmq",
"value": "rabbitmq",
"brief": "RabbitMQ",
"stability": "stable"
},
{
"id": "rocketmq",
"value": "rocketmq",
"brief": "Apache RocketMQ",
"stability": "stable"
}
]
},
"brief": "An identifier for the messaging system being used. See below for a list of well-known identifiers.\n",
"requirement_level": "required",
"stability": "stable"
},
{
"name": "messaging.system",
"type": {
"members": [
{
"id": "activemq",
"value": "activemq",
"brief": "Apache ActiveMQ",
"stability": "stable"
},
{
"id": "aws_sqs",
"value": "aws_sqs",
"brief": "Amazon Simple Queue Service (SQS)",
"stability": "stable"
},
{
"id": "azure_eventgrid",
"value": "azure_eventgrid",
"brief": "Azure Event Grid",
"stability": "stable"
},
{
"id": "azure_eventhubs",
"value": "azure_eventhubs",
"brief": "Azure Event Hubs",
"stability": "stable"
},
{
"id": "azure_servicebus",
"value": "azure_servicebus",
"brief": "Azure Service Bus",
"stability": "stable"
},
{
"id": "gcp_pubsub",
"value": "gcp_pubsub",
"brief": "Google Cloud Pub/Sub",
"stability": "stable"
},
{
"id": "jms",
"value": "jms",
"brief": "Java Message Service",
"stability": "stable"
},
{
"id": "kafka",
"value": "kafka",
"brief": "Apache Kafka",
"stability": "stable"
},
{
"id": "rabbitmq",
"value": "rabbitmq",
"brief": "RabbitMQ",
"stability": "stable"
},
{
"id": "rocketmq",
"value": "rocketmq",
"brief": "Apache RocketMQ",
"stability": "stable"
}
]
},
"brief": "An identifier for the messaging system being used. See below for a list of well-known identifiers.\n",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "network.carrier.icc",
"type": "string",
"brief": "The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network.",
"examples": "DE",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "network.carrier.mcc",
"type": "string",
"brief": "The mobile carrier country code.",
"examples": "310",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "network.carrier.mnc",
"type": "string",
"brief": "The mobile carrier network code.",
"examples": "001",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "network.carrier.name",
"type": "string",
"brief": "The name of the mobile carrier.",
"examples": "sprint",
"requirement_level": "recommended",
"stability": "stable"
},
{
"name": "network.connection.subtype",
"type": {
"members": [
{
"id": "gprs",
"value": "gprs",
"brief": "GPRS",
"stability": "stable"
},
{
"id": "edge",
"value": "edge",
"brief": "EDGE",
"stability": "stable"
},
{
"id": "umts",
"value": "umts",
"brief": "UMTS",
"stability": "stable"
},
{
"id": "cdma",
"value": "cdma",
"brief": "CDMA",
"stability": "stable"
},
{
"id": "evdo_0",
"value": "evdo_0",
"brief": "EVDO Rel. 0",
"stability": "stable"
},
{
"id": "evdo_a",
"value": "evdo_a",
"brief": "EVDO Rev. A",
"stability": "stable"
},
{
"id": "cdma2000_1xrtt",
"value": "cdma2000_1xrtt",
"brief": "CDMA2000 1XRTT",
"stability": "stable"
},
{
"id": "hsdpa",
"value": "hsdpa",
"brief": "HSDPA",
"stability": "stable"
},
{
"id": "hsupa",
"value": "hsupa",
"brief": "HSUPA",
"stability": "stable"
},
{
"id": "hspa",
"value": "hspa",
"brief": "HSPA",
"stability": "stable"
},
{
"id": "iden",
"value": "iden",
"brief": "IDEN",
"stability": "stable"
},
{
"id": "evdo_b",
"value": "evdo_b",
"brief": "EVDO Rev. B",
"stability": "stable"
},
{
"id": "lte",
"value": "lte",
"brief": "LTE",
"stability": "stable"
},
{
"id": "ehrpd",
"value": "ehrpd",
"brief": "EHRPD",
"stability": "stable"
},
{
"id": "hspap",
"value": "hspap",
"brief": "HSPAP",
"stability": "stable"
},
{
"id": "gsm",
"value": "gsm",
"brief": "GSM",
"stability": "stable"
},
{
"id": "td_scdma",
"value": "td_scdma",
"brief": "TD-SCDMA",
"stability": "stable"
},
{
"id": "iwlan",
"value": "iwlan",
"brief": "IWLAN",
"stability": "stable"
},
{
"id": "nr",
"value": "nr",
"brief": "5G NR (New Radio)",
"stability": "stable"
},
{
"id": "nrnsa",
"value": "nrnsa",
"brief": "5G NRNSA (New Radio Non-Standalone)",
"stability": "stable"
},
{
"id": "lte_ca",
"value": "lte_ca",
"brief": "LTE CA",
"stability": "stable"
}
]
},
"brief": "This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection.",