-
Notifications
You must be signed in to change notification settings - Fork 94
Expand file tree
/
Copy pathconfig-schema.json
More file actions
2439 lines (2439 loc) · 91.9 KB
/
config-schema.json
File metadata and controls
2439 lines (2439 loc) · 91.9 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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://go.opentelemetry.io/obi/pkg/obi/config",
"$defs": {
"AWSConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable AWS services (S3, SQS, etc.) payload extraction and parsing",
"x-env-var": "OTEL_EBPF_HTTP_AWS_ENABLED"
}
},
"type": "object"
},
"AgentTypeIface": {
"oneOf": [
{
"type": "string",
"enum": [
"external",
"local"
]
},
{
"type": "string",
"pattern": "^name:.+$"
}
],
"title": "Agent Type Interface",
"description": "Specifies which interface should the agent pick the IP address from in order to report it in the AgentIP field on each flow. Accepted values are: external, local, or name:<interface name> (e.g. name:eth0)."
},
"AnthropicConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable Anthropic payload extraction and parsing",
"x-env-var": "OTEL_EBPF_HTTP_ANTHROPIC_ENABLED"
}
},
"type": "object"
},
"AttributeFamilyConfig": {
"additionalProperties": {
"$ref": "#/$defs/MatchDefinition"
},
"type": "object",
"description": "AttributeFamilyConfig maps, for a given record, each attribute with its MatchDefinition"
},
"Attributes": {
"properties": {
"extra_group_attributes": {
"$ref": "#/$defs/ExtraGroupAttributesMap"
},
"host_id": {
"$ref": "#/$defs/HostIDConfig"
},
"instance_id": {
"$ref": "#/$defs/InstanceIDConfig"
},
"kubernetes": {
"$ref": "#/$defs/KubernetesDecorator"
},
"metadata_retry": {
"$ref": "#/$defs/RetryConfig"
},
"metric_span_names_limit": {
"type": "integer",
"description": "MetricSpanNameAggregationLimit works PER SERVICE and only relates to span_metrics. When the span_name cardinality surpasses this limit, the span_name will be reported as AGGREGATED. If the value <= 0, it is disabled.",
"x-env-var": "OTEL_EBPF_METRIC_SPAN_NAMES_LIMIT"
},
"rename_unresolved_hosts": {
"type": "string",
"description": "RenameUnresolvedHosts will replace HostName and PeerName attributes when they are empty or contain unresolved IP addresses to reduce cardinality. Set this value to the empty string to disable this feature.",
"x-env-var": "OTEL_EBPF_RENAME_UNRESOLVED_HOSTS"
},
"rename_unresolved_hosts_incoming": {
"type": "string",
"x-env-var": "OTEL_EBPF_RENAME_UNRESOLVED_HOSTS_INCOMING"
},
"rename_unresolved_hosts_outgoing": {
"type": "string",
"x-env-var": "OTEL_EBPF_RENAME_UNRESOLVED_HOSTS_OUTGOING"
},
"select": {
"$ref": "#/$defs/Selection"
}
},
"type": "object",
"description": "Attributes configures the decoration of some extra attributes that will be added to each span"
},
"AttributesConfig": {
"properties": {
"application": {
"$ref": "#/$defs/AttributeFamilyConfig"
},
"network": {
"$ref": "#/$defs/AttributeFamilyConfig"
},
"stats": {
"$ref": "#/$defs/AttributeFamilyConfig"
}
},
"type": "object",
"description": "AttributesConfig stores the user-provided section for filtering either Application or Network records by attribute values"
},
"BedrockConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable AWS Bedrock payload extraction and parsing",
"x-env-var": "OTEL_EBPF_HTTP_BEDROCK_ENABLED"
}
},
"type": "object"
},
"Buckets": {
"properties": {
"duration_histogram": {
"items": {
"type": "number"
},
"type": "array"
},
"gen_ai_client_operation_duration_histogram": {
"items": {
"type": "number"
},
"type": "array"
},
"gen_ai_client_token_usage_histogram": {
"items": {
"type": "number"
},
"type": "array"
},
"request_size_histogram": {
"items": {
"type": "number"
},
"type": "array"
},
"response_size_histogram": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object",
"description": "Buckets defines the histograms bucket boundaries, and allows users to redefine them"
},
"ContextPropagationMode": {
"oneOf": [
{
"type": "string",
"enum": [
"",
"all",
"disabled"
],
"description": "Enable all propagation methods, disable propagation, or use empty string for disabled"
},
{
"type": "string",
"pattern": "^(headers|http|tcp)(,(headers|http|tcp))*$",
"description": "List of propagation methods to enable (headers/http for HTTP headers, tcp for TCP options), separated by commas",
"examples": [
"headers",
"tcp",
"headers,tcp"
]
}
],
"title": "Context Propagation Mode",
"description": "Configures distributed context propagation. Can be 'all' to enable all methods, 'disabled'/'' to disable, or a list of specific methods: 'headers' (or 'http') for HTTP headers, 'tcp' for TCP options."
},
"CustomRoutesConfig": {
"properties": {
"incoming": {
"items": {
"type": "string"
},
"type": "array"
},
"outgoing": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Definitions": {
"items": {
"oneOf": [
{
"type": "string",
"description": "A CIDR range (e.g. \"10.0.0.0/8\"). The CIDR string is used as the attribute value."
},
{
"properties": {
"cidr": {
"type": "string",
"description": "A CIDR range (e.g. \"10.0.0.0/8\")."
},
"name": {
"type": "string",
"description": "A human-readable name for this CIDR. Used as the attribute value instead of the CIDR string."
}
},
"type": "object",
"required": [
"cidr"
],
"description": "A named CIDR entry."
}
]
},
"type": "array",
"description": "A list of CIDRs to be set as the \"src.cidr\" and \"dst.cidr\" attribute as a function of the source and destination IP addresses. Each entry can be a plain CIDR string or an object with \"cidr\" and \"name\" fields."
},
"DiscoveryConfig": {
"properties": {
"bpf_pid_filter_off": {
"type": "boolean",
"description": "Debugging only option. Make sure the kernel side doesn't filter any PIDs, force user space filtering.",
"x-env-var": "OTEL_EBPF_BPF_PID_FILTER_OFF"
},
"default_exclude_instrument": {
"$ref": "#/$defs/GlobDefinitionCriteria",
"description": "DefaultExcludeInstrument by default prevents self-instrumentation of OBI as well as related observability tools It must be set to an empty string or a different value if self-instrumentation is desired."
},
"default_exclude_services": {
"$ref": "#/$defs/RegexDefinitionCriteria",
"description": "DefaultExcludeServices by default prevents self-instrumentation of OBI as well as related observability tools It must be set to an empty string or a different value if self-instrumentation is desired. Use DefaultExcludeInstrument instead",
"deprecated": true
},
"default_otlp_grpc_port": {
"type": "integer",
"description": "DefaultOtlpGRPCPort specifies the default OTLP gRPC port (4317) to fallback on when missing environment variables on service, for checking for grpc export requests, defaults to 4317",
"x-env-var": "OTEL_EBPF_DEFAULT_OTLP_GRPC_PORT"
},
"disabled_route_harvesters": {
"items": {
"type": "string",
"enum": [
"go",
"java",
"nodejs"
]
},
"type": "array"
},
"exclude_instrument": {
"$ref": "#/$defs/GlobDefinitionCriteria",
"description": "ExcludeInstrument works analogously to Instrument, but the applications matching this section won't be instrumented even if they match the Instrument selection."
},
"exclude_otel_instrumented_services": {
"type": "boolean",
"description": "Disables instrumentation of services which are already instrumented",
"x-env-var": "OTEL_EBPF_EXCLUDE_OTEL_INSTRUMENTED_SERVICES"
},
"exclude_otel_instrumented_services_span_metrics": {
"type": "boolean",
"description": "Disables generation of span metrics of services which are already instrumented",
"x-env-var": "OTEL_EBPF_EXCLUDE_OTEL_INSTRUMENTED_SERVICES_SPAN_METRICS"
},
"exclude_services": {
"$ref": "#/$defs/RegexDefinitionCriteria",
"description": "ExcludeServices works analogously to Services, but the applications matching this section won't be instrumented even if they match the Services selection. Use ExcludeInstrument instead",
"deprecated": true
},
"excluded_linux_system_paths": {
"items": {
"type": "string"
},
"type": "array",
"description": "Executable paths for which we don't run language detection and cannot be selected using the path or language selection criteria"
},
"instrument": {
"$ref": "#/$defs/GlobDefinitionCriteria",
"description": "Instrument selects the services to instrument via Globs. If this section is set, both the Services and ExcludeServices section is ignored. If the user defined the OTEL_EBPF_INSTRUMENT_COMMAND or OTEL_EBPF_INSTRUMENT_PORTS variables, they will be automatically added to the instrument criteria, with the lowest preference."
},
"min_process_age": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "Min process age to be considered for discovery.",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_MIN_PROCESS_AGE"
},
"poll_interval": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "PollInterval specifies, for the poll service watcher, the interval time between process inspections",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_DISCOVERY_POLL_INTERVAL"
},
"route_harvester_advanced": {
"$ref": "#/$defs/RouteHarvestingConfig"
},
"route_harvester_timeout": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_ROUTE_HARVESTER_TIMEOUT"
},
"services": {
"$ref": "#/$defs/RegexDefinitionCriteria",
"description": "Services selection. If the user defined the OTEL_EBPF_EXECUTABLE_PATH or OTEL_EBPF_OPEN_PORT variables, they will be automatically added to the services definition criteria, with the lowest preference. Use Instrument instead",
"deprecated": true
},
"skip_go_specific_tracers": {
"type": "boolean",
"description": "This can be enabled to use generic HTTP tracers only, no Go-specifics will be used:",
"x-env-var": "OTEL_EBPF_SKIP_GO_SPECIFIC_TRACERS"
}
},
"type": "object",
"description": "DiscoveryConfig for the discover.ProcessFinder pipeline"
},
"EBPFBufferSizes": {
"properties": {
"http": {
"type": "integer",
"x-env-var": "OTEL_EBPF_BPF_BUFFER_SIZE_HTTP"
},
"kafka": {
"type": "integer",
"x-env-var": "OTEL_EBPF_BPF_BUFFER_SIZE_KAFKA"
},
"mysql": {
"type": "integer",
"x-env-var": "OTEL_EBPF_BPF_BUFFER_SIZE_MYSQL"
},
"postgres": {
"type": "integer",
"x-env-var": "OTEL_EBPF_BPF_BUFFER_SIZE_POSTGRES"
}
},
"type": "object",
"description": "Per-protocol maximum bytes to capture per request per direction, sent to userspace via large buffer events. Values must stay aligned with MaxCapturedPayloadBytes and the k_large_buf_max_*_captured_bytes constants in bpf/common/large_buffers.h. Default: 0 (disabled)."
},
"EBPFTracer": {
"properties": {
"batch_length": {
"type": "integer",
"description": "BatchLength allows specifying how many items (traces/metrics) will be batched at the initial stage before being forwarded to the next stage Must be at least 1",
"x-env-var": "OTEL_EBPF_BPF_BATCH_LENGTH"
},
"batch_timeout": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "BatchTimeout specifies the timeout to forward the data batch if it didn't reach the BatchLength size",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_BPF_BATCH_TIMEOUT"
},
"bpf_debug": {
"type": "boolean",
"description": "Enables logging of eBPF program events",
"x-env-var": "OTEL_EBPF_BPF_DEBUG"
},
"bpf_fs_path": {
"type": "string",
"description": "BPF path used to pin eBPF maps",
"x-env-var": "OTEL_EBPF_BPF_FS_PATH"
},
"buffer_sizes": {
"$ref": "#/$defs/EBPFBufferSizes",
"description": "Limit max data buffer size per protocol."
},
"context_propagation": {
"$ref": "#/$defs/ContextPropagationMode",
"description": "Enables distributed context propagation. Can be a combination of: headers, tcp (e.g., \"headers,tcp\" or \"all\")",
"x-env-var": "OTEL_EBPF_BPF_CONTEXT_PROPAGATION"
},
"couchbase_db_cache_size": {
"type": "integer",
"x-env-var": "OTEL_EBPF_COUCHBASE_DB_CACHE_SIZE"
},
"disable_black_box_cp": {
"type": "boolean",
"description": "Disables OBI black-box context propagation. Used for testing purposes only.",
"x-env-var": "OTEL_EBPF_BPF_DISABLE_BLACK_BOX_CP"
},
"dns_request_timeout": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "DNS timeout after which we report failed event",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_BPF_DNS_REQUEST_TIMEOUT"
},
"force_bpf_map_reader": {
"type": "string",
"enum": [
"auto",
"batch",
"legacy"
],
"description": "ForceBPFMapReader forces the PerCPU HashMap operation of the Network Flows reader. The system will always try \"batch\", which is more efficient, but legacy systems like RHEL8-based will fallback to \"legacy\" (the slowest, more resource-consuming iterate&delete approach).",
"x-env-var": "OTEL_EBPF_FORCE_BPF_MAP_READER"
},
"heuristic_sql_detect": {
"type": "boolean",
"description": "Enables the heuristic based detection of SQL requests. This can be used to detect talking to databases other than the ones we recognize in OBI, like Postgres and MySQL",
"x-env-var": "OTEL_EBPF_HEURISTIC_SQL_DETECT"
},
"high_request_volume": {
"type": "boolean",
"description": "Optimizes for getting requests information immediately when request response is seen",
"x-env-var": "OTEL_EBPF_BPF_HIGH_REQUEST_VOLUME"
},
"http_request_timeout": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "Must be at least 0",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_BPF_HTTP_REQUEST_TIMEOUT"
},
"instrument_cuda": {
"type": "integer",
"description": "Enables GPU instrumentation for CUDA kernel launches and allocations",
"x-env-var": "OTEL_EBPF_INSTRUMENT_CUDA"
},
"kafka_topic_uuid_cache_size": {
"type": "integer",
"description": "Kafka Topic UUID to Name cache size.",
"x-env-var": "OTEL_KAFKA_TOPIC_UUID_CACHE_SIZE"
},
"log_enricher": {
"$ref": "#/$defs/LogEnricherConfig",
"description": "Log trace-context enricher config"
},
"maps_config": {
"$ref": "#/$defs/MapsConfig",
"description": "eBPF map configurations"
},
"max_transaction_time": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "Maximum time allowed for two requests to be correlated as parent -> child Some programs (e.g. load generators) keep on generating requests from the same thread in perpetuity, which can generate very large traces. We want to mark the parent trace as invalid if this happens.",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_BPF_MAX_TRANSACTION_TIME"
},
"mongo_requests_cache_size": {
"type": "integer",
"description": "MongoDB requests cache size.",
"x-env-var": "OTEL_EBPF_BPF_MONGO_REQUESTS_CACHE_SIZE"
},
"mysql_prepared_statements_cache_size": {
"type": "integer",
"description": "MySQL prepared statements cache size.",
"x-env-var": "OTEL_EBPF_BPF_MYSQL_PREPARED_STATEMENTS_CACHE_SIZE"
},
"override_bpfloop_enabled": {
"type": "boolean",
"description": "Skips checking the kernel version for bpf_loop functionality. Some modified kernels have this backported prior to version 5.17.",
"x-env-var": "OTEL_EBPF_OVERRIDE_BPF_LOOP_ENABLED"
},
"payload_extraction": {
"$ref": "#/$defs/PayloadExtraction",
"description": "Configure data extraction/parsing based on protocol"
},
"postgres_prepared_statements_cache_size": {
"type": "integer",
"description": "Postgres prepared statements cache size.",
"x-env-var": "OTEL_EBPF_BPF_POSTGRES_PREPARED_STATEMENTS_CACHE_SIZE"
},
"protocol_debug_print": {
"type": "boolean",
"description": "Enables debug printing of the protocol data",
"x-env-var": "OTEL_EBPF_PROTOCOL_DEBUG_PRINT"
},
"redis_db_cache": {
"$ref": "#/$defs/RedisDBCacheConfig"
},
"track_request_headers": {
"type": "boolean",
"description": "If enabled, the kprobes based HTTP request tracking will start tracking the request headers to process any 'Traceparent' fields.",
"x-env-var": "OTEL_EBPF_BPF_TRACK_REQUEST_HEADERS"
},
"traffic_control_backend": {
"type": "string",
"enum": [
"auto",
"tc",
"tcx"
],
"description": "Select the TC attachment backend: accepted values are 'tc' (netlink), and 'tcx'",
"x-env-var": "OTEL_EBPF_BPF_TC_BACKEND"
},
"wakeup_len": {
"type": "integer",
"description": "WakeupLen specifies how many messages need to be accumulated in the eBPF ringbuffer before sending a wakeup request. High values of WakeupLen could add a noticeable metric delay in services with low requests/second. Must be at least 0 TODO: see if there is a way to force eBPF to wakeup userspace on timeout",
"x-env-var": "OTEL_EBPF_BPF_WAKEUP_LEN"
}
},
"type": "object",
"description": "EBPFTracer configuration for eBPF programs"
},
"ElasticsearchConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable Elasticsearch payload extraction and parsing",
"x-env-var": "OTEL_EBPF_HTTP_ELASTICSEARCH_ENABLED"
}
},
"type": "object"
},
"EnrichmentConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable HTTP header and payload enrichment",
"x-env-var": "OTEL_EBPF_HTTP_ENRICHMENT_ENABLED"
},
"policy": {
"$ref": "#/$defs/HTTPParsingPolicy",
"description": "Policy controls the default behavior"
},
"rules": {
"items": {
"$ref": "#/$defs/HTTPParsingRule"
},
"type": "array",
"description": "Rules is an ordered list of include/exclude/obfuscate rules."
}
},
"type": "object",
"description": "EnrichmentConfig configures HTTP header and payload extraction with policy-based rules."
},
"ExportModes": {
"items": {
"type": "string",
"enum": [
"logs",
"metrics",
"traces"
]
},
"type": "array",
"description": "List of signals to export. If undefined or null, all signals are exported. If an empty list, no signals are exported."
},
"ExtraGroupAttributesMap": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"propertyNames": {
"enum": [
"k8s_app_meta"
]
},
"type": "object",
"description": "Map of attribute group names to arrays of attribute names. Only 'k8s_app_meta' is currently supported as a key."
},
"Features": {
"items": {
"type": "string",
"enum": [
"*",
"all",
"application",
"application_host",
"application_service_graph",
"application_span",
"application_span_otel",
"application_span_sizes",
"ebpf",
"network",
"network_inter_zone",
"stats"
]
},
"type": "array",
"description": "List of metric features to enable."
},
"GeminiConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable Google AI Studio (Gemini) payload extraction and parsing",
"x-env-var": "OTEL_EBPF_HTTP_GEMINI_ENABLED"
}
},
"type": "object"
},
"GenAIConfig": {
"properties": {
"anthropic": {
"$ref": "#/$defs/AnthropicConfig",
"description": "Anthropic payload extraction and parsing"
},
"bedrock": {
"$ref": "#/$defs/BedrockConfig",
"description": "AWS Bedrock payload extraction and parsing"
},
"gemini": {
"$ref": "#/$defs/GeminiConfig",
"description": "Google AI Studio (Gemini) payload extraction and parsing"
},
"mcp": {
"$ref": "#/$defs/MCPConfig",
"description": "Model Context Protocol (MCP) payload extraction and parsing"
},
"openai": {
"$ref": "#/$defs/OpenAIConfig",
"description": "OpenAI payload extraction and parsing"
}
},
"type": "object"
},
"GeoIP": {
"properties": {
"cache_expiry": {
"type": "string",
"pattern": "^[0-9]+(ms|s|m)$",
"description": "It also accepts OTEL_EBPF_NETWORK_GEOIP_CACHE_TTL for backwards-compatibility",
"examples": [
"30s",
"5m",
"1ms"
],
"x-env-var": "OTEL_EBPF_GEOIP_CACHE_TTL"
},
"cache_len": {
"type": "integer",
"description": "It also accepts OTEL_EBPF_NETWORK_GEOIP_CACHE_LEN for backwards-compatibility",
"x-env-var": "OTEL_EBPF_GEOIP_CACHE_LEN"
},
"ipinfo": {
"$ref": "#/$defs/IPInfoConfig"
},
"maxmind": {
"$ref": "#/$defs/MaxMindConfig"
}
},
"type": "object",
"description": "GeoIP is currently experimental. It is kept disabled by default and will be hidden from the documentation. This means that it does not impact in the overall OBI performance."
},
"GlobAttr": {
"type": "string",
"format": "glob",
"description": "Glob pattern to match against the attribute value",
"examples": [
"app-*",
"service-??",
"prod-*-db"
]
},
"GlobAttributes": {
"properties": {
"cmd_args": {
"$ref": "#/$defs/GlobAttr",
"description": "CmdArgs allows to limit by matching command line arguments"
},
"container_name": {
"$ref": "#/$defs/GlobAttr"
},
"containers_only": {
"type": "boolean",
"description": "ContainersOnly restricts the discovery to processes which are running inside a container"
},
"exe_path": {
"$ref": "#/$defs/GlobAttr",
"description": "Path allows defining the regular expression matching the full executable path."
},
"exports": {
"$ref": "#/$defs/ExportModes",
"description": "Configures what to export. Allowed values are 'metrics', 'traces', or an empty array (disabled). An unspecified value (nil) will use the default configuration value"
},
"k8s_container_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_cronjob_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_daemonset_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_deployment_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_job_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_namespace": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_owner_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_pod_annotations": {
"additionalProperties": {
"$ref": "#/$defs/GlobAttr"
},
"type": "object",
"description": "PodAnnotations allows matching against the annotations of a pod"
},
"k8s_pod_labels": {
"additionalProperties": {
"$ref": "#/$defs/GlobAttr"
},
"type": "object",
"description": "PodLabels allows matching against the labels of a pod"
},
"k8s_pod_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_replicaset_name": {
"$ref": "#/$defs/GlobAttr"
},
"k8s_statefulset_name": {
"$ref": "#/$defs/GlobAttr"
},
"languages": {
"$ref": "#/$defs/GlobAttr",
"description": "Language allows defining services to instrument based on the programming language they are written in. Use lowercase names, e.g. java,go"
},
"metrics": {
"$ref": "#/$defs/SvcMetricsConfig",
"description": "Metrics configuration that is custom for this service match",
"x-env-var": "-"
},
"name": {
"type": "string",
"description": "Name will define a name for the matching service. If unset, it will take the name of the executable process, from the OTEL_SERVICE_NAME env var of the instrumented process, or from other metadata like Kubernetes annotations. Name should be set in the instrumentation target via kube metadata or standard env vars. To be kept undocumented until we remove it.",
"deprecated": true
},
"namespace": {
"type": "string",
"description": "Namespace will define a namespace for the matching service. If unset, it will be left empty. Namespace should be set in the instrumentation target via kube metadata or standard env vars. To be kept undocumented until we remove it.",
"deprecated": true
},
"open_ports": {
"$ref": "#/$defs/IntEnum",
"description": "OpenPorts allows defining a group of ports that this service could open. It accepts a comma-separated list of port numbers (e.g. 80) and port ranges (e.g. 8080-8089)"
},
"routes": {
"$ref": "#/$defs/CustomRoutesConfig"
},
"sampler": {
"$ref": "#/$defs/SamplerConfig"
},
"target_pids": {
"items": {
"type": "integer"
},
"type": "array",
"description": "PIDs allows selecting processes by PID (static from config). When non-empty, the process PID must be in this list.",
"x-env-var": "OTEL_EBPF_TARGET_PID"
}
},
"type": "object"
},
"GlobDefinitionCriteria": {
"items": {
"$ref": "#/$defs/GlobAttributes"
},
"type": "array",
"description": "GlobDefinitionCriteria allows defining a group of services to be instrumented according to a set of attributes. If a given executable/service matches multiple of the attributes, the earliest defined service will take precedence."
},
"GraphQLConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable GraphQL payload extraction and parsing",
"x-env-var": "OTEL_EBPF_HTTP_GRAPHQL_ENABLED"
}
},
"type": "object"
},
"HTTPConfig": {
"properties": {
"aws": {
"$ref": "#/$defs/AWSConfig",
"description": "AWS payload extraction and parsing"
},
"elasticsearch": {
"$ref": "#/$defs/ElasticsearchConfig",
"description": "Elasticsearch payload extraction and parsing"
},
"enrichment": {
"$ref": "#/$defs/EnrichmentConfig",
"description": "Enrichment configures HTTP header and payload extraction with policy-based rules"
},
"genai": {
"$ref": "#/$defs/GenAIConfig",
"description": "GenAI payload extraction"
},
"graphql": {
"$ref": "#/$defs/GraphQLConfig",
"description": "GraphQL payload extraction and parsing"
},
"jsonrpc": {
"$ref": "#/$defs/JSONRPCConfig",
"description": "JSON-RPC payload extraction and parsing"
},
"sqlpp": {
"$ref": "#/$defs/SQLPPConfig",
"description": "SQL++ payload extraction and parsing (Couchbase and other SQL++ databases)"
}
},
"type": "object"
},
"HTTPMethod": {
"type": "string",
"enum": [
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"PATCH",
"POST",
"PUT"
]
},
"HTTPParsingAction": {
"type": "string",
"enum": [
"exclude",
"include",
"obfuscate"
]
},
"HTTPParsingDefaultAction": {
"properties": {
"body": {
"$ref": "#/$defs/HTTPParsingAction"
},
"headers": {
"$ref": "#/$defs/HTTPParsingAction"
}
},
"type": "object",
"description": "HTTPParsingDefaultAction specifies the default action per rule type."
},
"HTTPParsingMatch": {
"properties": {
"case_sensitive": {
"type": "boolean",
"description": "CaseSensitive controls whether header matching is case-sensitive (headers only)"
},
"methods": {
"items": {
"$ref": "#/$defs/HTTPMethod"
},
"type": "array",
"description": "Methods is a list of HTTP methods this rule applies to (shared). Empty means all methods."
},
"obfuscation_json_paths": {
"items": {
"$ref": "#/$defs/JSONPathExpr"
},
"type": "array",
"description": "ObfuscationJSONPaths is a list of JSONPath expressions for fields to obfuscate (body only)"
},
"patterns": {
"items": {
"$ref": "#/$defs/GlobAttr"
},
"type": "array",
"description": "Patterns is a list of glob patterns to match header names against (headers only)"
},
"url_path_patterns": {
"items": {
"$ref": "#/$defs/GlobAttr"
},
"type": "array",
"description": "URLPathPatterns is a list of glob patterns to match the request path against (shared)"
}
},
"type": "object",
"description": "HTTPParsingMatch defines matching criteria for an HTTP parsing rule. Header rules use Patterns and CaseSensitive. Body rules use ObfuscationJSONPaths. URLPathPatterns and Methods are shared across both types."
},
"HTTPParsingPolicy": {
"properties": {
"default_action": {
"$ref": "#/$defs/HTTPParsingDefaultAction",
"description": "DefaultAction specifies what to do when no rule matches, per type."
},
"obfuscation_string": {
"type": "string",
"description": "ObfuscationString is the replacement string used when a rule's action is \"obfuscate\"",
"x-env-var": "OTEL_EBPF_HTTP_ENRICHMENT_OBFUSCATION_STRING"
}
},
"type": "object",
"description": "HTTPParsingPolicy defines the default action for http enrichment rules."
},
"HTTPParsingRule": {
"properties": {
"action": {
"$ref": "#/$defs/HTTPParsingAction",
"description": "Action of the rule: \"include\", \"exclude\", or \"obfuscate\""
},
"match": {
"$ref": "#/$defs/HTTPParsingMatch",
"description": "Match defines the matching criteria for this rule"
},
"scope": {
"$ref": "#/$defs/HTTPParsingScope",
"description": "Scope of the rule: \"request\", \"response\", or \"all\""
},
"type": {
"$ref": "#/$defs/HTTPParsingRuleType",
"description": "Type specifies what this rule matches against: \"headers\" or \"body\""
}
},
"type": "object",
"description": "HTTPParsingRule defines a single include/exclude/obfuscate rule for HTTP header and payload extraction."
},
"HTTPParsingRuleType": {
"type": "string",
"enum": [
"body",
"headers"
]
},
"HTTPParsingScope": {
"type": "string",
"enum": [
"all",
"request",
"response"
]
},
"HostIDConfig": {
"properties": {
"override": {
"type": "string",
"description": "Override allows overriding the reported host.id in OBI",
"x-env-var": "OTEL_EBPF_HOST_ID"
}
},
"type": "object"
},
"IPInfoConfig": {
"properties": {
"path": {
"type": "string",
"description": "It also accepts OTEL_EBPF_NETWORK_GEOIP_IPINFO_PATH for backwards-compatibility",
"x-env-var": "OTEL_EBPF_GEOIP_IPINFO_PATH"
}
},
"type": "object"
},
"InclusionLists": {
"properties": {
"exclude": {
"items": {
"type": "string"
},
"type": "array",
"description": "Exclude will remove attributes from the include list (or the default attribute set). It can be an attribute name or a wildcard."
},
"include": {
"items": {
"type": "string"
},
"type": "array",
"description": "Include is a list of metric attributes that have to be reported. It can be an attribute name or a wildcard (e.g. k8s.dst.* to include all the attributes starting with k8s.dst). If no include list is provided, the default attribute set will be reported."
}
},
"type": "object"
},
"InstanceIDConfig": {
"properties": {
"dns": {