-
Notifications
You must be signed in to change notification settings - Fork 857
Expand file tree
/
Copy pathcortex-config-schema.json
More file actions
9103 lines (9103 loc) · 445 KB
/
cortex-config-schema.json
File metadata and controls
9103 lines (9103 loc) · 445 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
{
"$id": "https://raw.githubusercontent.com/cortexproject/cortex/master/schemas/cortex-config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"DisabledRuleGroup": {
"properties": {
"name": {
"description": "name of the rule group",
"type": "string"
},
"namespace": {
"description": "namespace in which the rule group belongs",
"type": "string"
}
},
"type": "object"
},
"Label": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"LimitsPerLabelSet": {
"properties": {
"label_set": {
"additionalProperties": true,
"default": [],
"description": "LabelSet which the limit should be applied. If no labels are provided, it becomes the default partition which matches any series that doesn't match any other explicitly defined label sets.'",
"type": "object"
},
"limits": {
"properties": {
"max_series": {
"description": "The maximum number of active series per LabelSet, across the cluster before replication. Setting the value 0 will enable the monitoring (metrics) but would not enforce any limits.",
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"PriorityDef": {
"properties": {
"priority": {
"default": 0,
"description": "Priority level. Must be a unique value.",
"type": "number"
},
"query_attributes": {
"default": [],
"description": "List of query_attributes to match and assign priority to queries. A query is assigned to this priority if it matches any query_attribute in this list. Each query_attribute has several properties (e.g., regex, time_window, user_agent), and all specified properties must match for a query_attribute to be considered a match. Only the specified properties are checked, and an AND operator is applied to them.",
"items": {
"type": "string"
},
"type": "array"
},
"reserved_queriers": {
"default": 0,
"description": "Number of reserved queriers to handle priorities higher or equal to the priority level. Value between 0 and 1 will be used as a percentage.",
"type": "number"
}
},
"type": "object"
},
"QueryAttribute": {
"properties": {
"api_type": {
"description": "API type for the query. Should be one of the query, query_range, series, labels, label_values. If not set, it won't be checked.",
"type": "string"
},
"dashboard_uid": {
"description": "Grafana includes X-Dashboard-Uid header in query requests. If this field is provided then X-Dashboard-Uid header of request should match this value. If not set, it won't be checked. This property won't be applied to metadata queries.",
"type": "string"
},
"panel_id": {
"description": "Grafana includes X-Panel-Id header in query requests. If this field is provided then X-Panel-Id header of request should match this value. If not set, it won't be checked. This property won't be applied to metadata queries.",
"type": "string"
},
"query_step_limit": {
"description": "If query step provided should be within this limit to match. If not set, it won't be checked. This property only applied to range queries and ignored for other types of queries.",
"properties": {
"max": {
"default": 0,
"description": "Query step should be below or equal to this value to match. If set to 0, it won't be checked.",
"type": "number"
},
"min": {
"default": 0,
"description": "Query step should be above or equal to this value to match. If set to 0, it won't be checked.",
"type": "number"
}
},
"type": "object"
},
"regex": {
"description": "Regex that the query string (or at least one of the matchers in metadata query) should match. If not set, it won't be checked.",
"type": "string"
},
"time_range_limit": {
"description": "Query time range should be within this limit to match. Depending on where it was used, in most of the use-cases, either min or max value will be used. If not set, it won't be checked.",
"properties": {
"max": {
"default": 0,
"description": "This will be duration (12h, 1d, 15d etc.). Query time range should be below or equal to this value to match. Ex: if this value is 24h, then queries whose range is smaller than or equal to 24h will match.If set to 0, it won't be checked.",
"type": "number"
},
"min": {
"default": 0,
"description": "This will be duration (12h, 1d, 15d etc.). Query time range should be above or equal to this value to match. Ex: if this value is 20d, then queries whose range is bigger than or equal to 20d will match. If set to 0, it won't be checked.",
"type": "number"
}
},
"type": "object"
},
"time_window": {
"description": "Overall data select time window (including range selectors, modifiers and lookback delta) that the query should be within. If not set, it won't be checked.",
"properties": {
"end": {
"default": 0,
"description": "End of the data select time window (including range selectors, modifiers and lookback delta) that the query should be within. If set to 0, it won't be checked.",
"type": "number"
},
"start": {
"default": 0,
"description": "Start of the data select time window (including range selectors, modifiers and lookback delta) that the query should be within. If set to 0, it won't be checked.",
"type": "number"
}
},
"type": "object"
},
"user_agent_regex": {
"description": "Regex that User-Agent header of the request should match. If not set, it won't be checked.",
"type": "string"
}
},
"type": "object"
},
"alertmanager_config": {
"description": "The alertmanager_config configures the Cortex alertmanager.",
"properties": {
"alertmanager_client": {
"properties": {
"connect_timeout": {
"default": "5s",
"description": "The maximum amount of time to establish a connection. A value of 0 means using default gRPC client connect timeout 5s.",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.connect-timeout",
"x-format": "duration"
},
"grpc_compression": {
"description": "Use compression when sending messages. Supported values are: 'gzip', 'snappy' and '' (disable compression)",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.grpc-compression"
},
"max_recv_msg_size": {
"default": 16777216,
"description": "gRPC client max receive message size (bytes).",
"type": "number",
"x-cli-flag": "alertmanager.alertmanager-client.grpc-max-recv-msg-size"
},
"max_send_msg_size": {
"default": 4194304,
"description": "gRPC client max send message size (bytes).",
"type": "number",
"x-cli-flag": "alertmanager.alertmanager-client.grpc-max-send-msg-size"
},
"remote_timeout": {
"default": "2s",
"description": "Timeout for downstream alertmanagers.",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.remote-timeout",
"x-format": "duration"
},
"tls_ca_path": {
"description": "Path to the CA certificates file to validate server certificate against. If not set, the host's root CA certificates are used.",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.tls-ca-path"
},
"tls_cert_path": {
"description": "Path to the client certificate file, which will be used for authenticating with the server. Also requires the key path to be configured.",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.tls-cert-path"
},
"tls_enabled": {
"default": false,
"description": "Enable TLS in the GRPC client. This flag needs to be enabled when any other TLS flag is set. If set to false, insecure connection to gRPC server will be used.",
"type": "boolean",
"x-cli-flag": "alertmanager.alertmanager-client.tls-enabled"
},
"tls_insecure_skip_verify": {
"default": false,
"description": "Skip validating server certificate.",
"type": "boolean",
"x-cli-flag": "alertmanager.alertmanager-client.tls-insecure-skip-verify"
},
"tls_key_path": {
"description": "Path to the key file for the client certificate. Also requires the client certificate to be configured.",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.tls-key-path"
},
"tls_server_name": {
"description": "Override the expected name on the server certificate.",
"type": "string",
"x-cli-flag": "alertmanager.alertmanager-client.tls-server-name"
}
},
"type": "object"
},
"api_concurrency": {
"default": 0,
"description": "Maximum number of concurrent GET API requests before returning an error.",
"type": "number",
"x-cli-flag": "alertmanager.api-concurrency"
},
"auto_webhook_root": {
"description": "Root of URL to generate if config is http://internal.monitor",
"type": "string",
"x-cli-flag": "alertmanager.configs.auto-webhook-root"
},
"cluster": {
"properties": {
"advertise_address": {
"description": "Explicit address or hostname to advertise in cluster.",
"type": "string",
"x-cli-flag": "alertmanager.cluster.advertise-address"
},
"gossip_interval": {
"default": "200ms",
"description": "The interval between sending gossip messages. By lowering this value (more frequent) gossip messages are propagated across cluster more quickly at the expense of increased bandwidth usage.",
"type": "string",
"x-cli-flag": "alertmanager.cluster.gossip-interval",
"x-format": "duration"
},
"listen_address": {
"default": "0.0.0.0:9094",
"description": "Listen address and port for the cluster. Not specifying this flag disables high-availability mode.",
"type": "string",
"x-cli-flag": "alertmanager.cluster.listen-address"
},
"peer_timeout": {
"default": "15s",
"description": "Time to wait between peers to send notifications.",
"type": "string",
"x-cli-flag": "alertmanager.cluster.peer-timeout",
"x-format": "duration"
},
"peers": {
"description": "Comma-separated list of initial peers.",
"type": "string",
"x-cli-flag": "alertmanager.cluster.peers"
},
"push_pull_interval": {
"default": "1m0s",
"description": "The interval between gossip state syncs. Setting this interval lower (more frequent) will increase convergence speeds across larger clusters at the expense of increased bandwidth usage.",
"type": "string",
"x-cli-flag": "alertmanager.cluster.push-pull-interval",
"x-format": "duration"
}
},
"type": "object"
},
"data_dir": {
"default": "data/",
"description": "Base path for data storage.",
"type": "string",
"x-cli-flag": "alertmanager.storage.path"
},
"disabled_tenants": {
"description": "Comma separated list of tenants whose alerts this alertmanager cannot process. If specified, a alertmanager that would normally pick the specified tenant(s) for processing will ignore them instead.",
"type": "string",
"x-cli-flag": "alertmanager.disabled-tenants"
},
"enable_api": {
"default": false,
"description": "Enable the experimental alertmanager config api.",
"type": "boolean",
"x-cli-flag": "experimental.alertmanager.enable-api"
},
"enabled_tenants": {
"description": "Comma separated list of tenants whose alerts this alertmanager can process. If specified, only these tenants will be handled by alertmanager, otherwise this alertmanager can process alerts from all tenants.",
"type": "string",
"x-cli-flag": "alertmanager.enabled-tenants"
},
"external_url": {
"description": "The URL under which Alertmanager is externally reachable (for example, if Alertmanager is served via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by Alertmanager. If omitted, relevant URL components will be derived automatically.",
"format": "uri",
"type": "string",
"x-cli-flag": "alertmanager.web.external-url"
},
"fallback_config_file": {
"description": "Filename of fallback config to use if none specified for instance.",
"type": "string",
"x-cli-flag": "alertmanager.configs.fallback"
},
"gc_interval": {
"default": "30m0s",
"description": "Alertmanager alerts Garbage collection interval.",
"type": "string",
"x-cli-flag": "alertmanager.alerts-gc-interval",
"x-format": "duration"
},
"max_recv_msg_size": {
"default": 16777216,
"description": "Maximum size (bytes) of an accepted HTTP request body.",
"type": "number",
"x-cli-flag": "alertmanager.max-recv-msg-size"
},
"persist_interval": {
"default": "15m0s",
"description": "The interval between persisting the current alertmanager state (notification log and silences) to object storage. This is only used when sharding is enabled. This state is read when all replicas for a shard can not be contacted. In this scenario, having persisted the state more frequently will result in potentially fewer lost silences, and fewer duplicate notifications.",
"type": "string",
"x-cli-flag": "alertmanager.persist-interval",
"x-format": "duration"
},
"poll_interval": {
"default": "15s",
"description": "How frequently to poll Cortex configs",
"type": "string",
"x-cli-flag": "alertmanager.configs.poll-interval",
"x-format": "duration"
},
"retention": {
"default": "120h0m0s",
"description": "How long to keep data for.",
"type": "string",
"x-cli-flag": "alertmanager.storage.retention",
"x-format": "duration"
},
"sharding_enabled": {
"default": false,
"description": "Shard tenants across multiple alertmanager instances.",
"type": "boolean",
"x-cli-flag": "alertmanager.sharding-enabled"
},
"sharding_ring": {
"properties": {
"detailed_metrics_enabled": {
"default": true,
"description": "Set to true to enable ring detailed metrics. These metrics provide detailed information, such as token count and ownership per tenant. Disabling them can significantly decrease the number of metrics emitted.",
"type": "boolean",
"x-cli-flag": "alertmanager.sharding-ring.detailed-metrics-enabled"
},
"disable_replica_set_extension": {
"default": false,
"description": "Disable extending the replica set when instances are unhealthy. This limits blast radius during config corruption incidents but reduces availability during normal failures.",
"type": "boolean",
"x-cli-flag": "alertmanager.sharding-ring.disable-replica-set-extension"
},
"final_sleep": {
"default": "0s",
"description": "The sleep seconds when alertmanager is shutting down. Need to be close to or larger than KV Store information propagation delay",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.final-sleep",
"x-format": "duration"
},
"heartbeat_period": {
"default": "15s",
"description": "Period at which to heartbeat to the ring. 0 = disabled.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.heartbeat-period",
"x-format": "duration"
},
"heartbeat_timeout": {
"default": "1m0s",
"description": "The heartbeat timeout after which alertmanagers are considered unhealthy within the ring. 0 = never (timeout disabled).",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.heartbeat-timeout",
"x-format": "duration"
},
"instance_availability_zone": {
"description": "The availability zone where this instance is running. Required if zone-awareness is enabled.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.instance-availability-zone"
},
"instance_interface_names": {
"default": "[eth0 en0]",
"description": "Name of network interface to read address from.",
"items": {
"type": "string"
},
"type": "array",
"x-cli-flag": "alertmanager.sharding-ring.instance-interface-names"
},
"keep_instance_in_the_ring_on_shutdown": {
"default": false,
"description": "Keep instance in the ring on shut down.",
"type": "boolean",
"x-cli-flag": "alertmanager.sharding-ring.keep-instance-in-the-ring-on-shutdown"
},
"kvstore": {
"description": "The key-value store used to share the hash ring across multiple instances.",
"properties": {
"consul": {
"$ref": "#/definitions/consul_config"
},
"dynamodb": {
"properties": {
"max_cas_retries": {
"default": 10,
"description": "Maximum number of retries for DDB KV CAS.",
"type": "number",
"x-cli-flag": "alertmanager.sharding-ring.dynamodb.max-cas-retries"
},
"puller_sync_time": {
"default": "1m0s",
"description": "Time to refresh local ring with information on dynamodb.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.dynamodb.puller-sync-time",
"x-format": "duration"
},
"region": {
"description": "Region to access dynamodb.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.dynamodb.region"
},
"table_name": {
"description": "Table name to use on dynamodb.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.dynamodb.table-name"
},
"timeout": {
"default": "2m0s",
"description": "Timeout of dynamoDbClient requests. Default is 2m.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.dynamodb.timeout",
"x-format": "duration"
},
"ttl": {
"default": "0s",
"description": "Time to expire items on dynamodb.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.dynamodb.ttl-time",
"x-format": "duration"
}
},
"type": "object"
},
"etcd": {
"$ref": "#/definitions/etcd_config"
},
"multi": {
"properties": {
"mirror_enabled": {
"default": false,
"description": "Mirror writes to secondary store.",
"type": "boolean",
"x-cli-flag": "alertmanager.sharding-ring.multi.mirror-enabled"
},
"mirror_timeout": {
"default": "2s",
"description": "Timeout for storing value to secondary store.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.multi.mirror-timeout",
"x-format": "duration"
},
"primary": {
"description": "Primary backend storage used by multi-client.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.multi.primary"
},
"secondary": {
"description": "Secondary backend storage used by multi-client.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.multi.secondary"
}
},
"type": "object"
},
"prefix": {
"default": "alertmanagers/",
"description": "The prefix for the keys in the store. Should end with a /.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.prefix"
},
"store": {
"default": "consul",
"description": "Backend storage to use for the ring. Supported values are: consul, dynamodb, etcd, inmemory, memberlist, multi.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.store"
}
},
"type": "object"
},
"replication_factor": {
"default": 3,
"description": "The replication factor to use when sharding the alertmanager.",
"type": "number",
"x-cli-flag": "alertmanager.sharding-ring.replication-factor"
},
"tokens_file_path": {
"description": "File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.tokens-file-path"
},
"wait_instance_state_timeout": {
"default": "10m0s",
"description": "Timeout for waiting on alertmanager to become desired state in the ring.",
"type": "string",
"x-cli-flag": "alertmanager.sharding-ring.wait-instance-state-timeout",
"x-format": "duration"
},
"zone_awareness_enabled": {
"default": false,
"description": "True to enable zone-awareness and replicate alerts across different availability zones.",
"type": "boolean",
"x-cli-flag": "alertmanager.sharding-ring.zone-awareness-enabled"
}
},
"type": "object"
}
},
"type": "object"
},
"alertmanager_storage_config": {
"description": "The alertmanager_storage_config configures the Cortex alertmanager storage backend.",
"properties": {
"azure": {
"properties": {
"account_key": {
"description": "Azure storage account key",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.account-key"
},
"account_name": {
"description": "Azure storage account name",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.account-name"
},
"connection_string": {
"description": "The values of `account-name` and `endpoint-suffix` values will not be ignored if `connection-string` is set. Use this method over `account-key` if you need to authenticate via a SAS token or if you use the Azurite emulator.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.connection-string"
},
"container_name": {
"description": "Azure storage container name",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.container-name"
},
"endpoint_suffix": {
"description": "Azure storage endpoint suffix without schema. The account name will be prefixed to this value to create the FQDN",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.endpoint-suffix"
},
"http": {
"properties": {
"expect_continue_timeout": {
"default": "1s",
"description": "The time to wait for a server's first response headers after fully writing the request headers if the request has an Expect header. 0 to send the request body immediately.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.expect-continue-timeout",
"x-format": "duration"
},
"idle_conn_timeout": {
"default": "1m30s",
"description": "The time an idle connection will remain idle before closing.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.http.idle-conn-timeout",
"x-format": "duration"
},
"insecure_skip_verify": {
"default": false,
"description": "If the client connects via HTTPS and this option is enabled, the client will accept any certificate and hostname.",
"type": "boolean",
"x-cli-flag": "alertmanager-storage.azure.http.insecure-skip-verify"
},
"max_connections_per_host": {
"default": 0,
"description": "Maximum number of connections per host. 0 means no limit.",
"type": "number",
"x-cli-flag": "alertmanager-storage.azure.max-connections-per-host"
},
"max_idle_connections": {
"default": 100,
"description": "Maximum number of idle (keep-alive) connections across all hosts. 0 means no limit.",
"type": "number",
"x-cli-flag": "alertmanager-storage.azure.max-idle-connections"
},
"max_idle_connections_per_host": {
"default": 100,
"description": "Maximum number of idle (keep-alive) connections to keep per-host. If 0, a built-in default value is used.",
"type": "number",
"x-cli-flag": "alertmanager-storage.azure.max-idle-connections-per-host"
},
"response_header_timeout": {
"default": "2m0s",
"description": "The amount of time the client will wait for a servers response headers.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.http.response-header-timeout",
"x-format": "duration"
},
"tls_handshake_timeout": {
"default": "10s",
"description": "Maximum time to wait for a TLS handshake. 0 means no limit.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.tls-handshake-timeout",
"x-format": "duration"
}
},
"type": "object"
},
"max_retries": {
"default": 20,
"description": "Number of retries for recoverable errors",
"type": "number",
"x-cli-flag": "alertmanager-storage.azure.max-retries"
},
"msi_resource": {
"description": "Deprecated: Azure storage MSI resource. It will be set automatically by Azure SDK.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.msi-resource"
},
"user_assigned_id": {
"description": "Azure storage MSI resource managed identity client Id. If not supplied default Azure credential will be used. Set it to empty if you need to authenticate via Azure Workload Identity.",
"type": "string",
"x-cli-flag": "alertmanager-storage.azure.user-assigned-id"
}
},
"type": "object"
},
"backend": {
"default": "s3",
"description": "Backend storage to use. Supported backends are: s3, gcs, azure, swift, filesystem, configdb, local.",
"type": "string",
"x-cli-flag": "alertmanager-storage.backend"
},
"configdb": {
"$ref": "#/definitions/configstore_config"
},
"filesystem": {
"properties": {
"dir": {
"description": "Local filesystem storage directory.",
"type": "string",
"x-cli-flag": "alertmanager-storage.filesystem.dir"
}
},
"type": "object"
},
"gcs": {
"properties": {
"bucket_name": {
"description": "GCS bucket name",
"type": "string",
"x-cli-flag": "alertmanager-storage.gcs.bucket-name"
},
"service_account": {
"description": "JSON representing either a Google Developers Console client_credentials.json file or a Google Developers service account key file. If empty, fallback to Google default logic.",
"type": "string",
"x-cli-flag": "alertmanager-storage.gcs.service-account"
}
},
"type": "object"
},
"local": {
"properties": {
"path": {
"description": "Path at which alertmanager configurations are stored.",
"type": "string",
"x-cli-flag": "alertmanager-storage.local.path"
}
},
"type": "object"
},
"s3": {
"properties": {
"access_key_id": {
"description": "S3 access key ID",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.access-key-id"
},
"bucket_lookup_type": {
"default": "auto",
"description": "The s3 bucket lookup style. Supported values are: auto, virtual-hosted, path.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.bucket-lookup-type"
},
"bucket_name": {
"description": "S3 bucket name",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.bucket-name"
},
"disable_dualstack": {
"default": false,
"description": "If enabled, S3 endpoint will use the non-dualstack variant.",
"type": "boolean",
"x-cli-flag": "alertmanager-storage.s3.disable-dualstack"
},
"endpoint": {
"description": "The S3 bucket endpoint. It could be an AWS S3 endpoint listed at https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an S3-compatible service in hostname:port format.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.endpoint"
},
"http": {
"properties": {
"expect_continue_timeout": {
"default": "1s",
"description": "The time to wait for a server's first response headers after fully writing the request headers if the request has an Expect header. 0 to send the request body immediately.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.expect-continue-timeout",
"x-format": "duration"
},
"idle_conn_timeout": {
"default": "1m30s",
"description": "The time an idle connection will remain idle before closing.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.http.idle-conn-timeout",
"x-format": "duration"
},
"insecure_skip_verify": {
"default": false,
"description": "If the client connects via HTTPS and this option is enabled, the client will accept any certificate and hostname.",
"type": "boolean",
"x-cli-flag": "alertmanager-storage.s3.http.insecure-skip-verify"
},
"max_connections_per_host": {
"default": 0,
"description": "Maximum number of connections per host. 0 means no limit.",
"type": "number",
"x-cli-flag": "alertmanager-storage.s3.max-connections-per-host"
},
"max_idle_connections": {
"default": 100,
"description": "Maximum number of idle (keep-alive) connections across all hosts. 0 means no limit.",
"type": "number",
"x-cli-flag": "alertmanager-storage.s3.max-idle-connections"
},
"max_idle_connections_per_host": {
"default": 100,
"description": "Maximum number of idle (keep-alive) connections to keep per-host. If 0, a built-in default value is used.",
"type": "number",
"x-cli-flag": "alertmanager-storage.s3.max-idle-connections-per-host"
},
"response_header_timeout": {
"default": "2m0s",
"description": "The amount of time the client will wait for a servers response headers.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.http.response-header-timeout",
"x-format": "duration"
},
"tls_handshake_timeout": {
"default": "10s",
"description": "Maximum time to wait for a TLS handshake. 0 means no limit.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.tls-handshake-timeout",
"x-format": "duration"
}
},
"type": "object"
},
"insecure": {
"default": false,
"description": "If enabled, use http:// for the S3 endpoint instead of https://. This could be useful in local dev/test environments while using an S3-compatible backend storage, like Minio.",
"type": "boolean",
"x-cli-flag": "alertmanager-storage.s3.insecure"
},
"list_objects_version": {
"description": "The list api version. Supported values are: v1, v2, and ''.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.list-objects-version"
},
"region": {
"description": "S3 region. If unset, the client will issue a S3 GetBucketLocation API call to autodetect it.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.region"
},
"secret_access_key": {
"description": "S3 secret access key",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.secret-access-key"
},
"send_content_md5": {
"default": true,
"description": "If true, attach MD5 checksum when upload objects and S3 uses MD5 checksum algorithm to verify the provided digest. If false, use CRC32C algorithm instead.",
"type": "boolean",
"x-cli-flag": "alertmanager-storage.s3.send-content-md5"
},
"signature_version": {
"default": "v4",
"description": "The signature version to use for authenticating against S3. Supported values are: v4, v2.",
"type": "string",
"x-cli-flag": "alertmanager-storage.s3.signature-version"
},
"sse": {
"$ref": "#/definitions/s3_sse_config"
}
},
"type": "object"
},
"swift": {
"properties": {
"application_credential_id": {
"description": "OpenStack Swift application credential ID.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.application-credential-id"
},
"application_credential_name": {
"description": "OpenStack Swift application credential name.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.application-credential-name"
},
"application_credential_secret": {
"description": "OpenStack Swift application credential secret.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.application-credential-secret"
},
"auth_url": {
"description": "OpenStack Swift authentication URL",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.auth-url"
},
"auth_version": {
"default": 0,
"description": "OpenStack Swift authentication API version. 0 to autodetect.",
"type": "number",
"x-cli-flag": "alertmanager-storage.swift.auth-version"
},
"connect_timeout": {
"default": "10s",
"description": "Time after which a connection attempt is aborted.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.connect-timeout",
"x-format": "duration"
},
"container_name": {
"description": "Name of the OpenStack Swift container to put chunks in.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.container-name"
},
"domain_id": {
"description": "OpenStack Swift user's domain ID.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.domain-id"
},
"domain_name": {
"description": "OpenStack Swift user's domain name.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.domain-name"
},
"max_retries": {
"default": 3,
"description": "Max retries on requests error.",
"type": "number",
"x-cli-flag": "alertmanager-storage.swift.max-retries"
},
"password": {
"description": "OpenStack Swift API key.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.password"
},
"project_domain_id": {
"description": "ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.project-domain-id"
},
"project_domain_name": {
"description": "Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.project-domain-name"
},
"project_id": {
"description": "OpenStack Swift project ID (v2,v3 auth only).",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.project-id"
},
"project_name": {
"description": "OpenStack Swift project name (v2,v3 auth only).",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.project-name"
},
"region_name": {
"description": "OpenStack Swift Region to use (v2,v3 auth only).",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.region-name"
},
"request_timeout": {
"default": "5s",
"description": "Time after which an idle request is aborted. The timeout watchdog is reset each time some data is received, so the timeout triggers after X time no data is received on a request.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.request-timeout",
"x-format": "duration"
},
"user_domain_id": {
"description": "OpenStack Swift user's domain ID.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.user-domain-id"
},
"user_domain_name": {
"description": "OpenStack Swift user's domain name.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.user-domain-name"
},
"user_id": {
"description": "OpenStack Swift user ID.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.user-id"
},
"username": {
"description": "OpenStack Swift username.",
"type": "string",
"x-cli-flag": "alertmanager-storage.swift.username"
}
},
"type": "object"
},
"users_scanner": {
"properties": {
"cache_ttl": {
"default": "0s",
"description": "TTL of the cached users. 0 disables caching and relies on caching at bucket client level.",
"type": "string",
"x-cli-flag": "alertmanager-storage.users-scanner.cache-ttl",
"x-format": "duration"
},
"max_stale_period": {
"default": "1h0m0s",
"description": "Maximum period of time to consider the user index as stale. Fall back to the base scanner if stale. Only valid when strategy is user_index.",
"type": "string",
"x-cli-flag": "alertmanager-storage.users-scanner.user-index.max-stale-period",
"x-format": "duration"
},
"strategy": {
"default": "list",
"description": "Strategy to use to scan users. Supported values are: list, user_index.",
"type": "string",
"x-cli-flag": "alertmanager-storage.users-scanner.strategy"
},
"update_interval": {
"default": "15m0s",
"description": "How frequently user index file is updated. It only takes effect when user scan strategy is user_index.",
"type": "string",
"x-cli-flag": "alertmanager-storage.users-scanner.user-index.update-interval",
"x-format": "duration"
}
},
"type": "object"
}
},
"type": "object"
},
"blocks_storage_config": {
"description": "The blocks_storage_config configures the blocks storage.",
"properties": {
"azure": {
"properties": {
"account_key": {
"description": "Azure storage account key",
"type": "string",
"x-cli-flag": "blocks-storage.azure.account-key"
},
"account_name": {
"description": "Azure storage account name",
"type": "string",
"x-cli-flag": "blocks-storage.azure.account-name"
},
"connection_string": {
"description": "The values of `account-name` and `endpoint-suffix` values will not be ignored if `connection-string` is set. Use this method over `account-key` if you need to authenticate via a SAS token or if you use the Azurite emulator.",
"type": "string",
"x-cli-flag": "blocks-storage.azure.connection-string"
},
"container_name": {
"description": "Azure storage container name",
"type": "string",
"x-cli-flag": "blocks-storage.azure.container-name"
},
"endpoint_suffix": {
"description": "Azure storage endpoint suffix without schema. The account name will be prefixed to this value to create the FQDN",
"type": "string",
"x-cli-flag": "blocks-storage.azure.endpoint-suffix"
},
"http": {
"properties": {
"expect_continue_timeout": {
"default": "1s",
"description": "The time to wait for a server's first response headers after fully writing the request headers if the request has an Expect header. 0 to send the request body immediately.",
"type": "string",
"x-cli-flag": "blocks-storage.azure.expect-continue-timeout",
"x-format": "duration"
},
"idle_conn_timeout": {
"default": "1m30s",
"description": "The time an idle connection will remain idle before closing.",
"type": "string",
"x-cli-flag": "blocks-storage.azure.http.idle-conn-timeout",
"x-format": "duration"
},
"insecure_skip_verify": {
"default": false,
"description": "If the client connects via HTTPS and this option is enabled, the client will accept any certificate and hostname.",
"type": "boolean",
"x-cli-flag": "blocks-storage.azure.http.insecure-skip-verify"
},
"max_connections_per_host": {
"default": 0,