-
Notifications
You must be signed in to change notification settings - Fork 774
/
SemanticAttributes.java
1537 lines (1324 loc) · 60.7 KB
/
SemanticAttributes.java
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
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.semconv.trace.attributes;
import static io.opentelemetry.api.common.AttributeKey.booleanKey;
import static io.opentelemetry.api.common.AttributeKey.doubleKey;
import static io.opentelemetry.api.common.AttributeKey.longKey;
import static io.opentelemetry.api.common.AttributeKey.stringArrayKey;
import static io.opentelemetry.api.common.AttributeKey.stringKey;
import io.opentelemetry.api.common.AttributeKey;
import java.util.List;
// DO NOT EDIT, this is an Auto-generated file from
// buildscripts/semantic-convention/templates/SemanticAttributes.java.j2
@SuppressWarnings("unused")
public final class SemanticAttributes {
/** The URL of the OpenTelemetry schema for these keys and values. */
public static final String SCHEMA_URL = "https://opentelemetry.io/schemas/1.15.0";
/**
* The type of the exception (its fully-qualified class name, if applicable). The dynamic type of
* the exception should be preferred over the static type in languages that support it.
*/
public static final AttributeKey<String> EXCEPTION_TYPE = stringKey("exception.type");
/** The exception message. */
public static final AttributeKey<String> EXCEPTION_MESSAGE = stringKey("exception.message");
/**
* A stacktrace as a string in the natural representation for the language runtime. The
* representation is to be determined and documented by each language SIG.
*/
public static final AttributeKey<String> EXCEPTION_STACKTRACE = stringKey("exception.stacktrace");
/** The name identifies the event. */
public static final AttributeKey<String> EVENT_NAME = stringKey("event.name");
/**
* The domain identifies the context in which an event happened. An event name is unique only
* within a domain.
*
* <p>Notes:
*
* <ul>
* <li>An {@code event.name} is supposed to be unique only in the context of an {@code
* event.domain}, so this allows for two events in different domains to have same {@code
* event.name}, yet be unrelated events.
* </ul>
*/
public static final AttributeKey<String> EVENT_DOMAIN = stringKey("event.domain");
/** The name of the instrumentation scope - ({@code InstrumentationScope.Name} in OTLP). */
public static final AttributeKey<String> OTEL_SCOPE_NAME = stringKey("otel.scope.name");
/** The version of the instrumentation scope - ({@code InstrumentationScope.Version} in OTLP). */
public static final AttributeKey<String> OTEL_SCOPE_VERSION = stringKey("otel.scope.version");
/**
* Deprecated, use the {@code otel.scope.name} attribute.
*
* @deprecated Deprecated, use the `otel.scope.name` attribute.
*/
@Deprecated
public static final AttributeKey<String> OTEL_LIBRARY_NAME = stringKey("otel.library.name");
/**
* Deprecated, use the {@code otel.scope.version} attribute.
*
* @deprecated Deprecated, use the `otel.scope.version` attribute.
*/
@Deprecated
public static final AttributeKey<String> OTEL_LIBRARY_VERSION = stringKey("otel.library.version");
/**
* The full invoked ARN as provided on the {@code Context} passed to the function ({@code
* Lambda-Runtime-Invoked-Function-Arn} header on the {@code /runtime/invocation/next}
* applicable).
*
* <p>Notes:
*
* <ul>
* <li>This may be different from {@code faas.id} if an alias is involved.
* </ul>
*/
public static final AttributeKey<String> AWS_LAMBDA_INVOKED_ARN =
stringKey("aws.lambda.invoked_arn");
/**
* The <a
* href="https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id">event_id</a>
* uniquely identifies the event.
*/
public static final AttributeKey<String> CLOUDEVENTS_EVENT_ID = stringKey("cloudevents.event_id");
/**
* The <a
* href="https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1">source</a>
* identifies the context in which an event happened.
*/
public static final AttributeKey<String> CLOUDEVENTS_EVENT_SOURCE =
stringKey("cloudevents.event_source");
/**
* The <a
* href="https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion">version
* of the CloudEvents specification</a> which the event uses.
*/
public static final AttributeKey<String> CLOUDEVENTS_EVENT_SPEC_VERSION =
stringKey("cloudevents.event_spec_version");
/**
* The <a
* href="https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type">event_type</a>
* contains a value describing the type of event related to the originating occurrence.
*/
public static final AttributeKey<String> CLOUDEVENTS_EVENT_TYPE =
stringKey("cloudevents.event_type");
/**
* The <a
* href="https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject">subject</a>
* of the event in the context of the event producer (identified by source).
*/
public static final AttributeKey<String> CLOUDEVENTS_EVENT_SUBJECT =
stringKey("cloudevents.event_subject");
/**
* Parent-child Reference type
*
* <p>Notes:
*
* <ul>
* <li>The causal relationship between a child Span and a parent Span.
* </ul>
*/
public static final AttributeKey<String> OPENTRACING_REF_TYPE = stringKey("opentracing.ref_type");
/**
* An identifier for the database management system (DBMS) product being used. See below for a
* list of well-known identifiers.
*/
public static final AttributeKey<String> DB_SYSTEM = stringKey("db.system");
/**
* The connection string used to connect to the database. It is recommended to remove embedded
* credentials.
*/
public static final AttributeKey<String> DB_CONNECTION_STRING = stringKey("db.connection_string");
/** Username for accessing the database. */
public static final AttributeKey<String> DB_USER = stringKey("db.user");
/**
* The fully-qualified class name of the <a
* href="https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/">Java Database Connectivity
* (JDBC)</a> driver used to connect.
*/
public static final AttributeKey<String> DB_JDBC_DRIVER_CLASSNAME =
stringKey("db.jdbc.driver_classname");
/**
* This attribute is used to report 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).
*
* <p>Notes:
*
* <ul>
* <li>In some SQL databases, the database name to be used is called "schema name". In
* case there are multiple layers that could be considered for database name (e.g. Oracle
* instance name and schema name), the database name to be used is the more specific layer
* (e.g. Oracle schema name).
* </ul>
*/
public static final AttributeKey<String> DB_NAME = stringKey("db.name");
/**
* The database statement being executed.
*
* <p>Notes:
*
* <ul>
* <li>The value may be sanitized to exclude sensitive information.
* </ul>
*/
public static final AttributeKey<String> DB_STATEMENT = stringKey("db.statement");
/**
* The name of the operation being executed, e.g. the <a
* href="https://docs.mongodb.com/manual/reference/command/#database-operations">MongoDB command
* name</a> such as {@code findAndModify}, or the SQL keyword.
*
* <p>Notes:
*
* <ul>
* <li>When setting this to an SQL keyword, it is not recommended to attempt any client-side
* parsing of {@code db.statement} just to get this property, but it should be set if the
* operation name is provided by the library being instrumented. If the SQL statement has an
* ambiguous operation, or performs more than one operation, this value may be omitted.
* </ul>
*/
public static final AttributeKey<String> DB_OPERATION = stringKey("db.operation");
/**
* The Microsoft SQL Server <a
* href="https://docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15">instance
* name</a> connecting to. This name is used to determine the port of a named instance.
*
* <p>Notes:
*
* <ul>
* <li>If setting a {@code db.mssql.instance_name}, {@code net.peer.port} is no longer required
* (but still recommended if non-standard).
* </ul>
*/
public static final AttributeKey<String> DB_MSSQL_INSTANCE_NAME =
stringKey("db.mssql.instance_name");
/** The fetch size used for paging, i.e. how many rows will be returned at once. */
public static final AttributeKey<Long> DB_CASSANDRA_PAGE_SIZE = longKey("db.cassandra.page_size");
/**
* The consistency level of the query. Based on consistency values from <a
* href="https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html">CQL</a>.
*/
public static final AttributeKey<String> DB_CASSANDRA_CONSISTENCY_LEVEL =
stringKey("db.cassandra.consistency_level");
/**
* The name of the primary table that the operation is acting upon, including the keyspace name
* (if applicable).
*
* <p>Notes:
*
* <ul>
* <li>This mirrors the db.sql.table attribute but references cassandra rather than sql. It is
* not recommended to attempt any client-side parsing of {@code db.statement} just to get
* this property, but it should be set if it is provided by the library being instrumented.
* If the operation is acting upon an anonymous table, or more than one table, this value
* MUST NOT be set.
* </ul>
*/
public static final AttributeKey<String> DB_CASSANDRA_TABLE = stringKey("db.cassandra.table");
/** Whether or not the query is idempotent. */
public static final AttributeKey<Boolean> DB_CASSANDRA_IDEMPOTENCE =
booleanKey("db.cassandra.idempotence");
/**
* The number of times a query was speculatively executed. Not set or {@code 0} if the query was
* not executed speculatively.
*/
public static final AttributeKey<Long> DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT =
longKey("db.cassandra.speculative_execution_count");
/** The ID of the coordinating node for a query. */
public static final AttributeKey<String> DB_CASSANDRA_COORDINATOR_ID =
stringKey("db.cassandra.coordinator.id");
/** The data center of the coordinating node for a query. */
public static final AttributeKey<String> DB_CASSANDRA_COORDINATOR_DC =
stringKey("db.cassandra.coordinator.dc");
/**
* The index of the database being accessed as used in the <a
* href="https://redis.io/commands/select">{@code SELECT} command</a>, provided as an integer. To
* be used instead of the generic {@code db.name} attribute.
*/
public static final AttributeKey<Long> DB_REDIS_DATABASE_INDEX =
longKey("db.redis.database_index");
/** The collection being accessed within the database stated in {@code db.name}. */
public static final AttributeKey<String> DB_MONGODB_COLLECTION =
stringKey("db.mongodb.collection");
/**
* The name of the primary table that the operation is acting upon, including the database name
* (if applicable).
*
* <p>Notes:
*
* <ul>
* <li>It is not recommended to attempt any client-side parsing of {@code db.statement} just to
* get this property, but it should be set if it is provided by the library being
* instrumented. If the operation is acting upon an anonymous table, or more than one table,
* this value MUST NOT be set.
* </ul>
*/
public static final AttributeKey<String> DB_SQL_TABLE = stringKey("db.sql.table");
/**
* Name of the code, either "OK" or "ERROR". MUST NOT be set if the status
* code is UNSET.
*/
public static final AttributeKey<String> OTEL_STATUS_CODE = stringKey("otel.status_code");
/** Description of the Status if it has a value, otherwise not set. */
public static final AttributeKey<String> OTEL_STATUS_DESCRIPTION =
stringKey("otel.status_description");
/**
* Type of the trigger which caused this function execution.
*
* <p>Notes:
*
* <ul>
* <li>For the server/consumer span on the incoming side, {@code faas.trigger} MUST be set.
* <li>Clients invoking FaaS instances usually cannot set {@code faas.trigger}, since they would
* typically need to look in the payload to determine the event type. If clients set it, it
* should be the same as the trigger that corresponding incoming would have (i.e., this has
* nothing to do with the underlying transport used to make the API call to invoke the
* lambda, which is often HTTP).
* </ul>
*/
public static final AttributeKey<String> FAAS_TRIGGER = stringKey("faas.trigger");
/** The execution ID of the current function execution. */
public static final AttributeKey<String> FAAS_EXECUTION = stringKey("faas.execution");
/**
* The name of the source on which the triggering operation was performed. For example, in Cloud
* Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name.
*/
public static final AttributeKey<String> FAAS_DOCUMENT_COLLECTION =
stringKey("faas.document.collection");
/** Describes the type of the operation that was performed on the data. */
public static final AttributeKey<String> FAAS_DOCUMENT_OPERATION =
stringKey("faas.document.operation");
/**
* A string containing the time when the data was accessed in the <a
* href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format expressed in
* <a href="https://www.w3.org/TR/NOTE-datetime">UTC</a>.
*/
public static final AttributeKey<String> FAAS_DOCUMENT_TIME = stringKey("faas.document.time");
/**
* The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the
* name of the file, and in Cosmos DB the table name.
*/
public static final AttributeKey<String> FAAS_DOCUMENT_NAME = stringKey("faas.document.name");
/**
* A string containing the function invocation time in the <a
* href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format expressed in
* <a href="https://www.w3.org/TR/NOTE-datetime">UTC</a>.
*/
public static final AttributeKey<String> FAAS_TIME = stringKey("faas.time");
/**
* A string containing the schedule period as <a
* href="https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm">Cron
* Expression</a>.
*/
public static final AttributeKey<String> FAAS_CRON = stringKey("faas.cron");
/**
* A boolean that is true if the serverless function is executed for the first time (aka
* cold-start).
*/
public static final AttributeKey<Boolean> FAAS_COLDSTART = booleanKey("faas.coldstart");
/**
* The name of the invoked function.
*
* <p>Notes:
*
* <ul>
* <li>SHOULD be equal to the {@code faas.name} resource attribute of the invoked function.
* </ul>
*/
public static final AttributeKey<String> FAAS_INVOKED_NAME = stringKey("faas.invoked_name");
/**
* The cloud provider of the invoked function.
*
* <p>Notes:
*
* <ul>
* <li>SHOULD be equal to the {@code cloud.provider} resource attribute of the invoked function.
* </ul>
*/
public static final AttributeKey<String> FAAS_INVOKED_PROVIDER =
stringKey("faas.invoked_provider");
/**
* The cloud region of the invoked function.
*
* <p>Notes:
*
* <ul>
* <li>SHOULD be equal to the {@code cloud.region} resource attribute of the invoked function.
* </ul>
*/
public static final AttributeKey<String> FAAS_INVOKED_REGION = stringKey("faas.invoked_region");
/** Transport protocol used. See note below. */
public static final AttributeKey<String> NET_TRANSPORT = stringKey("net.transport");
/** Application layer protocol used. The value SHOULD be normalized to lowercase. */
public static final AttributeKey<String> NET_APP_PROTOCOL_NAME =
stringKey("net.app.protocol.name");
/**
* Version of the application layer protocol used. See note below.
*
* <p>Notes:
*
* <ul>
* <li>{@code net.app.protocol.version} refers to the version of the protocol used and might be
* different from the protocol client's version. If the HTTP client used has a version of
* {@code 0.27.2}, but sends HTTP version {@code 1.1}, this attribute should be set to
* {@code 1.1}.
* </ul>
*/
public static final AttributeKey<String> NET_APP_PROTOCOL_VERSION =
stringKey("net.app.protocol.version");
/** Remote socket peer name. */
public static final AttributeKey<String> NET_SOCK_PEER_NAME = stringKey("net.sock.peer.name");
/**
* Remote socket peer address: IPv4 or IPv6 for internet protocols, path for local communication,
* <a href="https://man7.org/linux/man-pages/man7/address_families.7.html">etc</a>.
*/
public static final AttributeKey<String> NET_SOCK_PEER_ADDR = stringKey("net.sock.peer.addr");
/** Remote socket peer port. */
public static final AttributeKey<Long> NET_SOCK_PEER_PORT = longKey("net.sock.peer.port");
/**
* Protocol <a href="https://man7.org/linux/man-pages/man7/address_families.7.html">address
* family</a> which is used for communication.
*/
public static final AttributeKey<String> NET_SOCK_FAMILY = stringKey("net.sock.family");
/**
* Logical remote hostname, see note below.
*
* <p>Notes:
*
* <ul>
* <li>{@code net.peer.name} SHOULD NOT be set if capturing it would require an extra DNS
* lookup.
* </ul>
*/
public static final AttributeKey<String> NET_PEER_NAME = stringKey("net.peer.name");
/** Logical remote port number */
public static final AttributeKey<Long> NET_PEER_PORT = longKey("net.peer.port");
/** Logical local hostname or similar, see note below. */
public static final AttributeKey<String> NET_HOST_NAME = stringKey("net.host.name");
/** Logical local port number, preferably the one that the peer used to connect */
public static final AttributeKey<Long> NET_HOST_PORT = longKey("net.host.port");
/** Local socket address. Useful in case of a multi-IP host. */
public static final AttributeKey<String> NET_SOCK_HOST_ADDR = stringKey("net.sock.host.addr");
/** Local socket port number. */
public static final AttributeKey<Long> NET_SOCK_HOST_PORT = longKey("net.sock.host.port");
/** The internet connection type currently being used by the host. */
public static final AttributeKey<String> NET_HOST_CONNECTION_TYPE =
stringKey("net.host.connection.type");
/**
* 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.
*/
public static final AttributeKey<String> NET_HOST_CONNECTION_SUBTYPE =
stringKey("net.host.connection.subtype");
/** The name of the mobile carrier. */
public static final AttributeKey<String> NET_HOST_CARRIER_NAME =
stringKey("net.host.carrier.name");
/** The mobile carrier country code. */
public static final AttributeKey<String> NET_HOST_CARRIER_MCC = stringKey("net.host.carrier.mcc");
/** The mobile carrier network code. */
public static final AttributeKey<String> NET_HOST_CARRIER_MNC = stringKey("net.host.carrier.mnc");
/** The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. */
public static final AttributeKey<String> NET_HOST_CARRIER_ICC = stringKey("net.host.carrier.icc");
/**
* The <a href="../../resource/semantic_conventions/README.md#service">{@code service.name}</a> of
* the remote service. SHOULD be equal to the actual {@code service.name} resource attribute of
* the remote service if any.
*/
public static final AttributeKey<String> PEER_SERVICE = stringKey("peer.service");
/**
* Username or client_id extracted from the access token or <a
* href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> header in the inbound
* request from outside the system.
*/
public static final AttributeKey<String> ENDUSER_ID = stringKey("enduser.id");
/**
* Actual/assumed role the client is making the request under extracted from token or application
* security context.
*/
public static final AttributeKey<String> ENDUSER_ROLE = stringKey("enduser.role");
/**
* Scopes or granted authorities the client currently possesses extracted from token or
* application security context. The value would come from the scope associated with an <a
* href="https://tools.ietf.org/html/rfc6749#section-3.3">OAuth 2.0 Access Token</a> or an
* attribute value in a <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html">SAML
* 2.0 Assertion</a>.
*/
public static final AttributeKey<String> ENDUSER_SCOPE = stringKey("enduser.scope");
/** Current "managed" thread ID (as opposed to OS thread ID). */
public static final AttributeKey<Long> THREAD_ID = longKey("thread.id");
/** Current thread name. */
public static final AttributeKey<String> THREAD_NAME = stringKey("thread.name");
/**
* The method or function name, or equivalent (usually rightmost part of the code unit's name).
*/
public static final AttributeKey<String> CODE_FUNCTION = stringKey("code.function");
/**
* The "namespace" within which {@code code.function} is defined. Usually the qualified
* class or module name, such that {@code code.namespace} + some separator + {@code code.function}
* form a unique identifier for the code unit.
*/
public static final AttributeKey<String> CODE_NAMESPACE = stringKey("code.namespace");
/**
* The source code file name that identifies the code unit as uniquely as possible (preferably an
* absolute file path).
*/
public static final AttributeKey<String> CODE_FILEPATH = stringKey("code.filepath");
/**
* The line number in {@code code.filepath} best representing the operation. It SHOULD point
* within the code unit named in {@code code.function}.
*/
public static final AttributeKey<Long> CODE_LINENO = longKey("code.lineno");
/** HTTP request method. */
public static final AttributeKey<String> HTTP_METHOD = stringKey("http.method");
/** <a href="https://tools.ietf.org/html/rfc7231#section-6">HTTP response status code</a>. */
public static final AttributeKey<Long> HTTP_STATUS_CODE = longKey("http.status_code");
/**
* Kind of HTTP protocol used.
*
* <p>Notes:
*
* <ul>
* <li>If {@code net.transport} is not specified, it can be assumed to be {@code IP.TCP} except
* if {@code http.flavor} is {@code QUIC}, in which case {@code IP.UDP} is assumed.
* </ul>
*/
public static final AttributeKey<String> HTTP_FLAVOR = stringKey("http.flavor");
/**
* Value of the <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent">HTTP
* User-Agent</a> header sent by the client.
*/
public static final AttributeKey<String> HTTP_USER_AGENT = stringKey("http.user_agent");
/**
* 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 <a
* href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length">Content-Length</a>
* header. For requests using transport encoding, this should be the compressed size.
*/
public static final AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH =
longKey("http.request_content_length");
/**
* 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 <a
* href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length">Content-Length</a>
* header. For requests using transport encoding, this should be the compressed size.
*/
public static final AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH =
longKey("http.response_content_length");
/**
* Full HTTP request URL in the form {@code scheme://host[:port]/path?query[#fragment]}. Usually
* the fragment is not transmitted over HTTP, but if it is known, it should be included
* nevertheless.
*
* <p>Notes:
*
* <ul>
* <li>{@code http.url} MUST NOT contain credentials passed via URL in form of {@code
* https://username:password@www.example.com/}. In such case the attribute's value should be
* {@code https://www.example.com/}.
* </ul>
*/
public static final AttributeKey<String> HTTP_URL = stringKey("http.url");
/**
* The ordinal number of request resending attempt (for any reason, including redirects).
*
* <p>Notes:
*
* <ul>
* <li>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).
* </ul>
*/
public static final AttributeKey<Long> HTTP_RESEND_COUNT = longKey("http.resend_count");
/** The URI scheme identifying the used protocol. */
public static final AttributeKey<String> HTTP_SCHEME = stringKey("http.scheme");
/** The full request target as passed in a HTTP request line or equivalent. */
public static final AttributeKey<String> HTTP_TARGET = stringKey("http.target");
/**
* The matched route (path template in the format used by the respective server framework). See
* note below
*
* <p>Notes:
*
* <ul>
* <li>'http.route' 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.
* </ul>
*/
public static final AttributeKey<String> HTTP_ROUTE = stringKey("http.route");
/**
* The IP address of the original client behind all proxies, if known (e.g. from <a
* href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For">X-Forwarded-For</a>).
*
* <p>Notes:
*
* <ul>
* <li>This is not necessarily the same as {@code net.sock.peer.addr}, which would identify the
* network-level peer, which may be a proxy.
* <li>This attribute should be set when a source of information different from the one used for
* {@code net.sock.peer.addr}, is available even if that other source just confirms the same
* value as {@code net.sock.peer.addr}. Rationale: For {@code net.sock.peer.addr}, one
* typically does not know if it comes from a proxy, reverse proxy, or the actual client.
* Setting {@code http.client_ip} when it's the same as {@code net.sock.peer.addr} means
* that one is at least somewhat confident that the address is not that of the closest
* proxy.
* </ul>
*/
public static final AttributeKey<String> HTTP_CLIENT_IP = stringKey("http.client_ip");
/** The keys in the {@code RequestItems} object field. */
public static final AttributeKey<List<String>> AWS_DYNAMODB_TABLE_NAMES =
stringArrayKey("aws.dynamodb.table_names");
/** The JSON-serialized value of each item in the {@code ConsumedCapacity} response field. */
public static final AttributeKey<List<String>> AWS_DYNAMODB_CONSUMED_CAPACITY =
stringArrayKey("aws.dynamodb.consumed_capacity");
/** The JSON-serialized value of the {@code ItemCollectionMetrics} response field. */
public static final AttributeKey<String> AWS_DYNAMODB_ITEM_COLLECTION_METRICS =
stringKey("aws.dynamodb.item_collection_metrics");
/** The value of the {@code ProvisionedThroughput.ReadCapacityUnits} request parameter. */
public static final AttributeKey<Double> AWS_DYNAMODB_PROVISIONED_READ_CAPACITY =
doubleKey("aws.dynamodb.provisioned_read_capacity");
/** The value of the {@code ProvisionedThroughput.WriteCapacityUnits} request parameter. */
public static final AttributeKey<Double> AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY =
doubleKey("aws.dynamodb.provisioned_write_capacity");
/** The value of the {@code ConsistentRead} request parameter. */
public static final AttributeKey<Boolean> AWS_DYNAMODB_CONSISTENT_READ =
booleanKey("aws.dynamodb.consistent_read");
/** The value of the {@code ProjectionExpression} request parameter. */
public static final AttributeKey<String> AWS_DYNAMODB_PROJECTION =
stringKey("aws.dynamodb.projection");
/** The value of the {@code Limit} request parameter. */
public static final AttributeKey<Long> AWS_DYNAMODB_LIMIT = longKey("aws.dynamodb.limit");
/** The value of the {@code AttributesToGet} request parameter. */
public static final AttributeKey<List<String>> AWS_DYNAMODB_ATTRIBUTES_TO_GET =
stringArrayKey("aws.dynamodb.attributes_to_get");
/** The value of the {@code IndexName} request parameter. */
public static final AttributeKey<String> AWS_DYNAMODB_INDEX_NAME =
stringKey("aws.dynamodb.index_name");
/** The value of the {@code Select} request parameter. */
public static final AttributeKey<String> AWS_DYNAMODB_SELECT = stringKey("aws.dynamodb.select");
/** The JSON-serialized value of each item of the {@code GlobalSecondaryIndexes} request field */
public static final AttributeKey<List<String>> AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES =
stringArrayKey("aws.dynamodb.global_secondary_indexes");
/** The JSON-serialized value of each item of the {@code LocalSecondaryIndexes} request field. */
public static final AttributeKey<List<String>> AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES =
stringArrayKey("aws.dynamodb.local_secondary_indexes");
/** The value of the {@code ExclusiveStartTableName} request parameter. */
public static final AttributeKey<String> AWS_DYNAMODB_EXCLUSIVE_START_TABLE =
stringKey("aws.dynamodb.exclusive_start_table");
/** The the number of items in the {@code TableNames} response parameter. */
public static final AttributeKey<Long> AWS_DYNAMODB_TABLE_COUNT =
longKey("aws.dynamodb.table_count");
/** The value of the {@code ScanIndexForward} request parameter. */
public static final AttributeKey<Boolean> AWS_DYNAMODB_SCAN_FORWARD =
booleanKey("aws.dynamodb.scan_forward");
/** The value of the {@code Segment} request parameter. */
public static final AttributeKey<Long> AWS_DYNAMODB_SEGMENT = longKey("aws.dynamodb.segment");
/** The value of the {@code TotalSegments} request parameter. */
public static final AttributeKey<Long> AWS_DYNAMODB_TOTAL_SEGMENTS =
longKey("aws.dynamodb.total_segments");
/** The value of the {@code Count} response parameter. */
public static final AttributeKey<Long> AWS_DYNAMODB_COUNT = longKey("aws.dynamodb.count");
/** The value of the {@code ScannedCount} response parameter. */
public static final AttributeKey<Long> AWS_DYNAMODB_SCANNED_COUNT =
longKey("aws.dynamodb.scanned_count");
/** The JSON-serialized value of each item in the {@code AttributeDefinitions} request field. */
public static final AttributeKey<List<String>> AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS =
stringArrayKey("aws.dynamodb.attribute_definitions");
/**
* The JSON-serialized value of each item in the the {@code GlobalSecondaryIndexUpdates} request
* field.
*/
public static final AttributeKey<List<String>> AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES =
stringArrayKey("aws.dynamodb.global_secondary_index_updates");
/** The name of the operation being executed. */
public static final AttributeKey<String> GRAPHQL_OPERATION_NAME =
stringKey("graphql.operation.name");
/** The type of the operation being executed. */
public static final AttributeKey<String> GRAPHQL_OPERATION_TYPE =
stringKey("graphql.operation.type");
/**
* The GraphQL document being executed.
*
* <p>Notes:
*
* <ul>
* <li>The value may be sanitized to exclude sensitive information.
* </ul>
*/
public static final AttributeKey<String> GRAPHQL_DOCUMENT = stringKey("graphql.document");
/** A string identifying the messaging system. */
public static final AttributeKey<String> MESSAGING_SYSTEM = stringKey("messaging.system");
/**
* The message destination name. This might be equal to the span name but is required
* nevertheless.
*/
public static final AttributeKey<String> MESSAGING_DESTINATION =
stringKey("messaging.destination");
/** The kind of message destination */
public static final AttributeKey<String> MESSAGING_DESTINATION_KIND =
stringKey("messaging.destination_kind");
/** A boolean that is true if the message destination is temporary. */
public static final AttributeKey<Boolean> MESSAGING_TEMP_DESTINATION =
booleanKey("messaging.temp_destination");
/** The name of the transport protocol. */
public static final AttributeKey<String> MESSAGING_PROTOCOL = stringKey("messaging.protocol");
/** The version of the transport protocol. */
public static final AttributeKey<String> MESSAGING_PROTOCOL_VERSION =
stringKey("messaging.protocol_version");
/** Connection string. */
public static final AttributeKey<String> MESSAGING_URL = stringKey("messaging.url");
/**
* A value used by the messaging system as an identifier for the message, represented as a string.
*/
public static final AttributeKey<String> MESSAGING_MESSAGE_ID = stringKey("messaging.message_id");
/**
* The <a href="#conversations">conversation ID</a> identifying the conversation to which the
* message belongs, represented as a string. Sometimes called "Correlation ID".
*/
public static final AttributeKey<String> MESSAGING_CONVERSATION_ID =
stringKey("messaging.conversation_id");
/**
* The (uncompressed) size of the message payload in bytes. Also use this attribute if it is
* unknown whether the compressed or uncompressed payload size is reported.
*/
public static final AttributeKey<Long> MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES =
longKey("messaging.message_payload_size_bytes");
/** The compressed size of the message payload in bytes. */
public static final AttributeKey<Long> MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES =
longKey("messaging.message_payload_compressed_size_bytes");
/**
* A string identifying the kind of message consumption as defined in the <a
* href="#operation-names">Operation names</a> section above. If the operation is
* "send", this attribute MUST NOT be set, since the operation can be inferred from the
* span kind in that case.
*/
public static final AttributeKey<String> MESSAGING_OPERATION = stringKey("messaging.operation");
/**
* The identifier for the consumer receiving a message. For Kafka, set it to {@code
* {messaging.kafka.consumer_group} - {messaging.kafka.client_id}}, if both are present, or only
* {@code messaging.kafka.consumer_group}. For brokers, such as RabbitMQ and Artemis, set it to
* the {@code client_id} of the client consuming the message.
*/
public static final AttributeKey<String> MESSAGING_CONSUMER_ID =
stringKey("messaging.consumer_id");
/** RabbitMQ message routing key. */
public static final AttributeKey<String> MESSAGING_RABBITMQ_ROUTING_KEY =
stringKey("messaging.rabbitmq.routing_key");
/**
* Message keys in Kafka are used for grouping alike messages to ensure they're processed on the
* same partition. They differ from {@code messaging.message_id} in that they're not unique. If
* the key is {@code null}, the attribute MUST NOT be set.
*
* <p>Notes:
*
* <ul>
* <li>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.
* </ul>
*/
public static final AttributeKey<String> MESSAGING_KAFKA_MESSAGE_KEY =
stringKey("messaging.kafka.message_key");
/**
* Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not
* producers.
*/
public static final AttributeKey<String> MESSAGING_KAFKA_CONSUMER_GROUP =
stringKey("messaging.kafka.consumer_group");
/** Client Id for the Consumer or Producer that is handling the message. */
public static final AttributeKey<String> MESSAGING_KAFKA_CLIENT_ID =
stringKey("messaging.kafka.client_id");
/** Partition the message is sent to. */
public static final AttributeKey<Long> MESSAGING_KAFKA_PARTITION =
longKey("messaging.kafka.partition");
/** A boolean that is true if the message is a tombstone. */
public static final AttributeKey<Boolean> MESSAGING_KAFKA_TOMBSTONE =
booleanKey("messaging.kafka.tombstone");
/** Namespace of RocketMQ resources, resources in different namespaces are individual. */
public static final AttributeKey<String> MESSAGING_ROCKETMQ_NAMESPACE =
stringKey("messaging.rocketmq.namespace");
/**
* Name of the RocketMQ producer/consumer group that is handling the message. The client type is
* identified by the SpanKind.
*/
public static final AttributeKey<String> MESSAGING_ROCKETMQ_CLIENT_GROUP =
stringKey("messaging.rocketmq.client_group");
/** The unique identifier for each client. */
public static final AttributeKey<String> MESSAGING_ROCKETMQ_CLIENT_ID =
stringKey("messaging.rocketmq.client_id");
/**
* The timestamp in milliseconds that the delay message is expected to be delivered to consumer.
*/
public static final AttributeKey<Long> MESSAGING_ROCKETMQ_DELIVERY_TIMESTAMP =
longKey("messaging.rocketmq.delivery_timestamp");
/** The delay time level for delay message, which determines the message delay time. */
public static final AttributeKey<Long> MESSAGING_ROCKETMQ_DELAY_TIME_LEVEL =
longKey("messaging.rocketmq.delay_time_level");
/**
* 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.
*/
public static final AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_GROUP =
stringKey("messaging.rocketmq.message_group");
/** Type of message. */
public static final AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_TYPE =
stringKey("messaging.rocketmq.message_type");
/** The secondary classifier of message besides topic. */
public static final AttributeKey<String> MESSAGING_ROCKETMQ_MESSAGE_TAG =
stringKey("messaging.rocketmq.message_tag");
/** Key(s) of message, another way to mark message besides message id. */
public static final AttributeKey<List<String>> MESSAGING_ROCKETMQ_MESSAGE_KEYS =
stringArrayKey("messaging.rocketmq.message_keys");
/** Model of message consumption. This only applies to consumer spans. */
public static final AttributeKey<String> MESSAGING_ROCKETMQ_CONSUMPTION_MODEL =
stringKey("messaging.rocketmq.consumption_model");
/** A string identifying the remoting system. See below for a list of well-known identifiers. */
public static final AttributeKey<String> RPC_SYSTEM = stringKey("rpc.system");
/**
* The full (logical) name of the service being called, including its package name, if applicable.
*
* <p>Notes:
*
* <ul>
* <li>This is the logical name of the service from the RPC interface perspective, which can be
* different from the name of any implementing class. The {@code code.namespace} attribute
* may be used to store the latter (despite the attribute name, it may include a class name;
* e.g., class with method actually executing the call on the server side, RPC client stub
* class on the client side).
* </ul>
*/
public static final AttributeKey<String> RPC_SERVICE = stringKey("rpc.service");
/**
* The name of the (logical) method being called, must be equal to the $method part in the span
* name.
*
* <p>Notes:
*
* <ul>
* <li>This is the logical name of the method from the RPC interface perspective, which can be
* different from the name of any implementing method/function. The {@code code.function}
* attribute may be used to store the latter (e.g., method actually executing the call on
* the server side, RPC client stub method on the client side).
* </ul>
*/
public static final AttributeKey<String> RPC_METHOD = stringKey("rpc.method");
/**
* The <a href="https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md">numeric status
* code</a> of the gRPC request.
*/
public static final AttributeKey<Long> RPC_GRPC_STATUS_CODE = longKey("rpc.grpc.status_code");
/**
* Protocol version as in {@code jsonrpc} property of request/response. Since JSON-RPC 1.0 does
* not specify this, the value can be omitted.
*/
public static final AttributeKey<String> RPC_JSONRPC_VERSION = stringKey("rpc.jsonrpc.version");
/**
* {@code id} property of request or response. Since protocol allows id to be int, string, {@code
* null} or missing (for notifications), value is expected to be cast to string for simplicity.
* Use empty string in case of {@code null} value. Omit entirely if this is a notification.
*/
public static final AttributeKey<String> RPC_JSONRPC_REQUEST_ID =
stringKey("rpc.jsonrpc.request_id");
/** {@code error.code} property of response if it is an error response. */
public static final AttributeKey<Long> RPC_JSONRPC_ERROR_CODE = longKey("rpc.jsonrpc.error_code");
/** {@code error.message} property of response if it is an error response. */
public static final AttributeKey<String> RPC_JSONRPC_ERROR_MESSAGE =
stringKey("rpc.jsonrpc.error_message");
/** Whether this is a received or sent message. */
public static final AttributeKey<String> MESSAGE_TYPE = stringKey("message.type");
/**
* MUST be calculated as two different counters starting from {@code 1} one for sent messages and
* one for received message.
*
* <p>Notes:
*
* <ul>
* <li>This way we guarantee that the values will be consistent between different
* implementations.
* </ul>
*/
public static final AttributeKey<Long> MESSAGE_ID = longKey("message.id");
/** Compressed size of the message in bytes. */
public static final AttributeKey<Long> MESSAGE_COMPRESSED_SIZE =
longKey("message.compressed_size");