-
Notifications
You must be signed in to change notification settings - Fork 8
/
scrape-config.go
1800 lines (1469 loc) · 64.3 KB
/
scrape-config.go
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
// Package scrapeconfig provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/do87/oapi-codegen version v0.5.0 DO NOT EDIT.
package scrapeconfig
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"strings"
common "github.com/SchwarzIT/community-stackit-go-client/internal/common"
"github.com/SchwarzIT/community-stackit-go-client/pkg/validate"
"github.com/do87/oapi-codegen/pkg/runtime"
)
const (
BearerAuthScopes = "bearerAuth.Scopes"
)
// Defines values for JobScheme.
const (
JOB_SCHEME_HTTP JobScheme = "http"
JOB_SCHEME_HTTPS JobScheme = "https"
)
// Defines values for MetricsRelabelConfigAction.
const (
METRICS_RELABEL_CONFIG_ACTION_DROP MetricsRelabelConfigAction = "drop"
METRICS_RELABEL_CONFIG_ACTION_HASHMOD MetricsRelabelConfigAction = "hashmod"
METRICS_RELABEL_CONFIG_ACTION_KEEP MetricsRelabelConfigAction = "keep"
METRICS_RELABEL_CONFIG_ACTION_LABELDROP MetricsRelabelConfigAction = "labeldrop"
METRICS_RELABEL_CONFIG_ACTION_LABELKEEP MetricsRelabelConfigAction = "labelkeep"
METRICS_RELABEL_CONFIG_ACTION_LABELMAP MetricsRelabelConfigAction = "labelmap"
METRICS_RELABEL_CONFIG_ACTION_REPLACE MetricsRelabelConfigAction = "replace"
)
// Defines values for PartialUpdateJSONBodyMetricsRelabelConfigsAction.
const (
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_DROP PartialUpdateJSONBodyMetricsRelabelConfigsAction = "drop"
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_HASHMOD PartialUpdateJSONBodyMetricsRelabelConfigsAction = "hashmod"
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_KEEP PartialUpdateJSONBodyMetricsRelabelConfigsAction = "keep"
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELDROP PartialUpdateJSONBodyMetricsRelabelConfigsAction = "labeldrop"
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELKEEP PartialUpdateJSONBodyMetricsRelabelConfigsAction = "labelkeep"
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELMAP PartialUpdateJSONBodyMetricsRelabelConfigsAction = "labelmap"
PARTIAL_UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_REPLACE PartialUpdateJSONBodyMetricsRelabelConfigsAction = "replace"
)
// Defines values for PartialUpdateJSONBodyScheme.
const (
PARTIAL_UPDATE_JSON_BODY_SCHEME_HTTP PartialUpdateJSONBodyScheme = "http"
PARTIAL_UPDATE_JSON_BODY_SCHEME_HTTPS PartialUpdateJSONBodyScheme = "https"
)
// Defines values for CreateJSONBodyMetricsRelabelConfigsAction.
const (
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_DROP CreateJSONBodyMetricsRelabelConfigsAction = "drop"
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_HASHMOD CreateJSONBodyMetricsRelabelConfigsAction = "hashmod"
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_KEEP CreateJSONBodyMetricsRelabelConfigsAction = "keep"
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELDROP CreateJSONBodyMetricsRelabelConfigsAction = "labeldrop"
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELKEEP CreateJSONBodyMetricsRelabelConfigsAction = "labelkeep"
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELMAP CreateJSONBodyMetricsRelabelConfigsAction = "labelmap"
CREATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_REPLACE CreateJSONBodyMetricsRelabelConfigsAction = "replace"
)
// Defines values for CreateJSONBodyScheme.
const (
CREATE_JSON_BODY_SCHEME_HTTP CreateJSONBodyScheme = "http"
CREATE_JSON_BODY_SCHEME_HTTPS CreateJSONBodyScheme = "https"
)
// Defines values for UpdateJSONBodyMetricsRelabelConfigsAction.
const (
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_DROP UpdateJSONBodyMetricsRelabelConfigsAction = "drop"
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_HASHMOD UpdateJSONBodyMetricsRelabelConfigsAction = "hashmod"
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_KEEP UpdateJSONBodyMetricsRelabelConfigsAction = "keep"
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELDROP UpdateJSONBodyMetricsRelabelConfigsAction = "labeldrop"
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELKEEP UpdateJSONBodyMetricsRelabelConfigsAction = "labelkeep"
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_LABELMAP UpdateJSONBodyMetricsRelabelConfigsAction = "labelmap"
UPDATE_JSON_BODY_METRICS_RELABEL_CONFIGS_ACTION_REPLACE UpdateJSONBodyMetricsRelabelConfigsAction = "replace"
)
// Defines values for UpdateJSONBodyScheme.
const (
UPDATE_JSON_BODY_SCHEME_HTTP UpdateJSONBodyScheme = "http"
UPDATE_JSON_BODY_SCHEME_HTTPS UpdateJSONBodyScheme = "https"
)
// BasicAuth defines model for BasicAuth.
type BasicAuth struct {
Password string `json:"password"`
Username string `json:"username"`
}
// CreateJob defines model for CreateJob.
type CreateJob struct {
Data []Job `json:"data"`
Message string `json:"message"`
}
// DeleteJob defines model for DeleteJob.
type DeleteJob struct {
Data []Job `json:"data"`
Message string `json:"message"`
}
// Error defines model for Error.
type Error struct {
Errors *[]map[string]string `json:"errors,omitempty"`
Message string `json:"message"`
}
// GetAllJob defines model for GetAllJob.
type GetAllJob struct {
Data []Job `json:"data"`
Message string `json:"message"`
}
// GetJob defines model for GetJob.
type GetJob struct {
Data Job `json:"data"`
Message string `json:"message"`
}
// HTTPServiceSD defines model for HTTPServiceSD.
type HTTPServiceSD struct {
BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
Oauth2 *OAuth2 `json:"oauth2,omitempty"`
RefreshInterval *string `json:"refreshInterval,omitempty"`
TlsConfig *TLSConfig `json:"tlsConfig,omitempty"`
URL string `json:"url"`
}
// Job defines model for Job.
type Job struct {
BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
BearerToken *string `json:"bearerToken,omitempty"`
HonorLabels *bool `json:"honorLabels,omitempty"`
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
HttpSdConfigs *[]HTTPServiceSD `json:"httpSdConfigs,omitempty"`
JobName string `json:"jobName"`
MetricsPath *string `json:"metricsPath,omitempty"`
MetricsRelabelConfigs *[]MetricsRelabelConfig `json:"metricsRelabelConfigs,omitempty"`
Oauth2 *OAuth2 `json:"oauth2,omitempty"`
Params *map[string][]string `json:"params,omitempty"`
SampleLimit *int `json:"sampleLimit,omitempty"`
Scheme *JobScheme `json:"scheme,omitempty"`
ScrapeInterval string `json:"scrapeInterval"`
ScrapeTimeout string `json:"scrapeTimeout"`
StaticConfigs []StaticConfigs `json:"staticConfigs"`
TlsConfig *TLSConfig `json:"tlsConfig,omitempty"`
}
// JobScheme defines model for Job.Scheme.
type JobScheme string
// Message defines model for Message.
type Message struct {
Message string `json:"message"`
}
// MetricsRelabelConfig defines model for MetricsRelabelConfig.
type MetricsRelabelConfig struct {
Action *MetricsRelabelConfigAction `json:"action,omitempty"`
Modulus *int `json:"modulus,omitempty"`
Regex *string `json:"regex,omitempty"`
Replacement *string `json:"replacement,omitempty"`
Separator *string `json:"separator,omitempty"`
SourceLabels []string `json:"sourceLabels"`
TargetLabel *string `json:"targetLabel,omitempty"`
}
// MetricsRelabelConfigAction defines model for MetricsRelabelConfig.Action.
type MetricsRelabelConfigAction string
// OAuth2 defines model for OAuth2.
type OAuth2 struct {
ClientID string `json:"clientId"`
ClientSecret string `json:"clientSecret"`
Scopes *[]string `json:"scopes,omitempty"`
TlsConfig *TLSConfig `json:"tlsConfig,omitempty"`
TokenURL string `json:"tokenUrl"`
}
// PermissionDenied defines model for PermissionDenied.
type PermissionDenied struct {
Detail string `json:"detail"`
}
// StaticConfigs defines model for StaticConfigs.
type StaticConfigs struct {
Labels *map[string]string `json:"labels,omitempty"`
Targets []string `json:"targets"`
}
// TLSConfig defines model for TLSConfig.
type TLSConfig struct {
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
}
// DeleteParams defines parameters for Delete.
type DeleteParams struct {
// JobName Name of the jobs that should be deleted
JobName []string `form:"jobName" json:"jobName"`
}
// PartialUpdateJSONBody defines parameters for PartialUpdate.
type PartialUpdateJSONBody = []struct {
// BasicAuth Sets the 'Authorization' header on every scrape request with the configured username and password.
// `Additional Validators:`
// * if basicAuth is in the body no other authentication method should be in the body
BasicAuth *struct {
// Password password
Password *string `json:"password,omitempty"`
// Username username
Username *string `json:"username,omitempty"`
} `json:"basicAuth,omitempty"`
// BearerToken Sets the 'Authorization' header on every scrape request with the configured bearer token. It is mutually exclusive with 'bearer_token_file'.
// `Additional Validators:`
// * needs to be a valid bearer token
// * if bearerToken is in the body no other authentication method should be in the body
BearerToken *string `json:"bearerToken,omitempty"`
// HonorLabels Note that any globally configured 'external_labels' are unaffected by this setting. In communication with external systems, they are always applied only when a time series does not have a given label yet and are ignored otherwise.
HonorLabels *bool `json:"honorLabels,omitempty"`
// HonorTimeStamps honor_timestamps controls whether Prometheus respects the timestamps present in scraped data. If honor_timestamps is set to 'true', the timestamps of the metrics exposed by the target will be used.
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
// HttpSdConfigs HTTP-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms.
HttpSdConfigs *[]struct {
// BasicAuth Sets the 'Authorization' header on every scrape request with the configured username and password.
// `Additional Validators:`
// * if basicAuth is in the body no other authentication method should be in the body
BasicAuth *struct {
// Password password
Password *string `json:"password,omitempty"`
// Username username
Username *string `json:"username,omitempty"`
} `json:"basicAuth,omitempty"`
// Oauth2 OAuth 2.0 authentication using the client credentials grant type. Prometheus fetches an access token from the specified endpoint with the given client access and secret keys.
// `Additional Validators:`
// * if oauth2 is in the body no other authentication method should be in the body
Oauth2 *struct {
// ClientId clientId
ClientID string `json:"clientId"`
// ClientSecret clientSecret
ClientSecret string `json:"clientSecret"`
// Scopes The URL to fetch the token from.
Scopes *[]string `json:"scopes,omitempty"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
// TokenUrl The URL to fetch the token from.
TokenURL string `json:"tokenUrl"`
} `json:"oauth2,omitempty"`
// RefreshInterval Refresh interval to re-query the endpoint. E.g. 60s
// `Additional Validators:`
// * must be a valid time format* must be >= 60s
RefreshInterval *string `json:"refreshInterval,omitempty"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
// Url URL from which the targets are fetched.
URL string `json:"url"`
} `json:"httpSdConfigs,omitempty"`
// JobName The job name assigned to scraped metrics by default.
// `Additional Validators:`
// * must be unique
// * key and values should only include the characters: a-zA-Z0-9-
JobName string `json:"jobName"`
// MetricsPath The HTTP resource path on which to fetch metrics from targets. E.g. /metrics
MetricsPath *string `json:"metricsPath,omitempty"`
// MetricsRelabelConfigs List of metric relabel configurations
MetricsRelabelConfigs *[]struct {
// Action Action to perform based on regex matching.
// `Additional Validators:`
// * if action is replace, targetLabel needs to be in body
Action *PartialUpdateJSONBodyMetricsRelabelConfigsAction `json:"action,omitempty"`
// Modulus Modulus to take of the hash of the source label values.
Modulus *float32 `json:"modulus,omitempty"`
// Regex Regular expression against which the extracted value is matched.
Regex *string `json:"regex,omitempty"`
// Replacement Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available.
Replacement *string `json:"replacement,omitempty"`
// Separator Separator placed between concatenated source label values.
Separator *string `json:"separator,omitempty"`
// SourceLabels The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
SourceLabels *[]string `json:"sourceLabels,omitempty"`
// TargetLabel Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
TargetLabel *string `json:"targetLabel,omitempty"`
} `json:"metricsRelabelConfigs,omitempty"`
// Oauth2 OAuth 2.0 authentication using the client credentials grant type. Prometheus fetches an access token from the specified endpoint with the given client access and secret keys.
// `Additional Validators:`
// * if oauth2 is in the body no other authentication method should be in the body
Oauth2 *struct {
// ClientId clientId
ClientID string `json:"clientId"`
// ClientSecret clientSecret
ClientSecret string `json:"clientSecret"`
// Scopes The URL to fetch the token from.
Scopes *[]string `json:"scopes,omitempty"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
// TokenUrl The URL to fetch the token from.
TokenURL string `json:"tokenUrl"`
} `json:"oauth2,omitempty"`
// Params Optional http params
// `Additional Validators:`
// * should not contain more than 5 keys
// * each key and value should not have more than 200 characters
Params *map[string]interface{} `json:"params,omitempty"`
// SampleLimit Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabeling the entire scrape will be treated as failed. The total limit depends on the service plan target limits * samples
SampleLimit *float32 `json:"sampleLimit,omitempty"`
// Scheme Configures the protocol scheme used for requests. https or http
Scheme PartialUpdateJSONBodyScheme `json:"scheme"`
// ScrapeInterval How frequently to scrape targets from this job. E.g. 5m
// `Additional Validators:`
// * must be a valid time format* must be >= 60s
ScrapeInterval string `json:"scrapeInterval"`
// ScrapeTimeout Per-scrape timeout when scraping this job.
// `Additional Validators:`
// * must be a valid time format* must be smaller than scrapeInterval
ScrapeTimeout string `json:"scrapeTimeout"`
// StaticConfigs A list of scrape configurations.
StaticConfigs []struct {
// Labels Labels assigned to all metrics scraped from the targets.
// `Additional Validators:`
// * should not contain more than 10 keys
// * each key and value should not be longer than 200 characters
Labels *map[string]interface{} `json:"labels,omitempty"`
// Targets The targets specified by the static config.
Targets []string `json:"targets"`
} `json:"staticConfigs"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
}
// PartialUpdateJSONBodyMetricsRelabelConfigsAction defines parameters for PartialUpdate.
type PartialUpdateJSONBodyMetricsRelabelConfigsAction string
// PartialUpdateJSONBodyScheme defines parameters for PartialUpdate.
type PartialUpdateJSONBodyScheme string
// CreateJSONBody defines parameters for Create.
type CreateJSONBody struct {
// BasicAuth Sets the 'Authorization' header on every scrape request with the configured username and password.
// `Additional Validators:`
// * if basicAuth is in the body no other authentication method should be in the body
BasicAuth *struct {
// Password password
Password *string `json:"password,omitempty"`
// Username username
Username *string `json:"username,omitempty"`
} `json:"basicAuth,omitempty"`
// BearerToken Sets the 'Authorization' header on every scrape request with the configured bearer token. It is mutually exclusive with 'bearer_token_file'.
// `Additional Validators:`
// * needs to be a valid bearer token
// * if bearerToken is in the body no other authentication method should be in the body
BearerToken *string `json:"bearerToken,omitempty"`
// HonorLabels Note that any globally configured 'external_labels' are unaffected by this setting. In communication with external systems, they are always applied only when a time series does not have a given label yet and are ignored otherwise.
HonorLabels *bool `json:"honorLabels,omitempty"`
// HonorTimeStamps honor_timestamps controls whether Prometheus respects the timestamps present in scraped data. If honor_timestamps is set to 'true', the timestamps of the metrics exposed by the target will be used.
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
// HttpSdConfigs HTTP-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms.
HttpSdConfigs *[]struct {
// BasicAuth Sets the 'Authorization' header on every scrape request with the configured username and password.
// `Additional Validators:`
// * if basicAuth is in the body no other authentication method should be in the body
BasicAuth *struct {
// Password password
Password *string `json:"password,omitempty"`
// Username username
Username *string `json:"username,omitempty"`
} `json:"basicAuth,omitempty"`
// Oauth2 OAuth 2.0 authentication using the client credentials grant type. Prometheus fetches an access token from the specified endpoint with the given client access and secret keys.
// `Additional Validators:`
// * if oauth2 is in the body no other authentication method should be in the body
Oauth2 *struct {
// ClientId clientId
ClientID string `json:"clientId"`
// ClientSecret clientSecret
ClientSecret string `json:"clientSecret"`
// Scopes The URL to fetch the token from.
Scopes *[]string `json:"scopes,omitempty"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
// TokenUrl The URL to fetch the token from.
TokenURL string `json:"tokenUrl"`
} `json:"oauth2,omitempty"`
// RefreshInterval Refresh interval to re-query the endpoint. E.g. 60s
// `Additional Validators:`
// * must be a valid time format* must be >= 60s
RefreshInterval *string `json:"refreshInterval,omitempty"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
// Url URL from which the targets are fetched.
URL string `json:"url"`
} `json:"httpSdConfigs,omitempty"`
// JobName The job name assigned to scraped metrics by default.
// `Additional Validators:`
// * must be unique
// * key and values should only include the characters: a-zA-Z0-9-
JobName string `json:"jobName"`
// MetricsPath The HTTP resource path on which to fetch metrics from targets. E.g. /metrics
MetricsPath *string `json:"metricsPath,omitempty"`
// MetricsRelabelConfigs List of metric relabel configurations
MetricsRelabelConfigs *[]struct {
// Action Action to perform based on regex matching.
// `Additional Validators:`
// * if action is replace, targetLabel needs to be in body
Action *CreateJSONBodyMetricsRelabelConfigsAction `json:"action,omitempty"`
// Modulus Modulus to take of the hash of the source label values.
Modulus *float32 `json:"modulus,omitempty"`
// Regex Regular expression against which the extracted value is matched.
Regex *string `json:"regex,omitempty"`
// Replacement Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available.
Replacement *string `json:"replacement,omitempty"`
// Separator Separator placed between concatenated source label values.
Separator *string `json:"separator,omitempty"`
// SourceLabels The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
SourceLabels *[]string `json:"sourceLabels,omitempty"`
// TargetLabel Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
TargetLabel *string `json:"targetLabel,omitempty"`
} `json:"metricsRelabelConfigs,omitempty"`
// Oauth2 OAuth 2.0 authentication using the client credentials grant type. Prometheus fetches an access token from the specified endpoint with the given client access and secret keys.
// `Additional Validators:`
// * if oauth2 is in the body no other authentication method should be in the body
Oauth2 *struct {
// ClientId clientId
ClientID string `json:"clientId"`
// ClientSecret clientSecret
ClientSecret string `json:"clientSecret"`
// Scopes The URL to fetch the token from.
Scopes *[]string `json:"scopes,omitempty"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
// TokenUrl The URL to fetch the token from.
TokenURL string `json:"tokenUrl"`
} `json:"oauth2,omitempty"`
// Params Optional http params
// `Additional Validators:`
// * should not contain more than 5 keys
// * each key and value should not have more than 200 characters
Params *map[string]interface{} `json:"params,omitempty"`
// SampleLimit Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabeling the entire scrape will be treated as failed. The total limit depends on the service plan target limits * samples
SampleLimit *float32 `json:"sampleLimit,omitempty"`
// Scheme Configures the protocol scheme used for requests. https or http
Scheme CreateJSONBodyScheme `json:"scheme"`
// ScrapeInterval How frequently to scrape targets from this job. E.g. 5m
// `Additional Validators:`
// * must be a valid time format* must be >= 60s
ScrapeInterval string `json:"scrapeInterval"`
// ScrapeTimeout Per-scrape timeout when scraping this job.
// `Additional Validators:`
// * must be a valid time format* must be smaller than scrapeInterval
ScrapeTimeout string `json:"scrapeTimeout"`
// StaticConfigs A list of scrape configurations.
StaticConfigs []struct {
// Labels Labels assigned to all metrics scraped from the targets.
// `Additional Validators:`
// * should not contain more than 10 keys
// * each key and value should not be longer than 200 characters
Labels *map[string]interface{} `json:"labels,omitempty"`
// Targets The targets specified by the static config.
Targets []string `json:"targets"`
} `json:"staticConfigs"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
}
// CreateJSONBodyMetricsRelabelConfigsAction defines parameters for Create.
type CreateJSONBodyMetricsRelabelConfigsAction string
// CreateJSONBodyScheme defines parameters for Create.
type CreateJSONBodyScheme string
// UpdateJSONBody defines parameters for Update.
type UpdateJSONBody struct {
// BasicAuth Sets the 'Authorization' header on every scrape request with the configured username and password.
// `Additional Validators:`
// * if basicAuth is in the body no other authentication method should be in the body
BasicAuth *struct {
// Password password
Password *string `json:"password,omitempty"`
// Username username
Username *string `json:"username,omitempty"`
} `json:"basicAuth,omitempty"`
// BearerToken Sets the 'Authorization' header on every scrape request with the configured bearer token. It is mutually exclusive with 'bearer_token_file'.
// `Additional Validators:`
// * needs to be a valid bearer token
// * if bearerToken is in the body no other authentication method should be in the body
BearerToken *string `json:"bearerToken,omitempty"`
// HonorLabels Note that any globally configured 'external_labels' are unaffected by this setting. In communication with external systems, they are always applied only when a time series does not have a given label yet and are ignored otherwise.
HonorLabels *bool `json:"honorLabels,omitempty"`
// HonorTimeStamps honor_timestamps controls whether Prometheus respects the timestamps present in scraped data. If honor_timestamps is set to 'true', the timestamps of the metrics exposed by the target will be used.
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
// MetricsPath The HTTP resource path on which to fetch metrics from targets. E.g. /metrics
MetricsPath string `json:"metricsPath"`
// MetricsRelabelConfigs List of metric relabel configurations
MetricsRelabelConfigs *[]struct {
// Action Action to perform based on regex matching.
// `Additional Validators:`
// * if action is replace, targetLabel needs to be in body
Action *UpdateJSONBodyMetricsRelabelConfigsAction `json:"action,omitempty"`
// Modulus Modulus to take of the hash of the source label values.
Modulus *float32 `json:"modulus,omitempty"`
// Regex Regular expression against which the extracted value is matched.
Regex *string `json:"regex,omitempty"`
// Replacement Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available.
Replacement *string `json:"replacement,omitempty"`
// Separator Separator placed between concatenated source label values.
Separator *string `json:"separator,omitempty"`
// SourceLabels The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
SourceLabels *[]string `json:"sourceLabels,omitempty"`
// TargetLabel Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
TargetLabel *string `json:"targetLabel,omitempty"`
} `json:"metricsRelabelConfigs,omitempty"`
// Params Optional http params
// `Additional Validators:`
// * should not contain more than 5 keys
// * each key and value should not have more than 200 characters
Params *map[string]interface{} `json:"params,omitempty"`
// Scheme Configures the protocol scheme used for requests. https or http
Scheme UpdateJSONBodyScheme `json:"scheme"`
// ScrapeInterval How frequently to scrape targets from this job. E.g. 5m
// `Additional Validators:`
// * must be a valid time format* must be >= 60s
ScrapeInterval string `json:"scrapeInterval"`
// ScrapeTimeout Per-scrape timeout when scraping this job.
// `Additional Validators:`
// * must be a valid time format* must be smaller than scrapeInterval
ScrapeTimeout string `json:"scrapeTimeout"`
// StaticConfigs A list of scrape configurations.
StaticConfigs []struct {
// Labels Labels assigned to all metrics scraped from the targets.
// `Additional Validators:`
// * should not contain more than 5 keys
// * each key and value should not be longer than 200 characters
Labels *map[string]interface{} `json:"labels,omitempty"`
// Targets The targets specified by the static config.
Targets []string `json:"targets"`
} `json:"staticConfigs"`
// TlsConfig Configures the scrape request's TLS settings.
TlsConfig *struct {
// InsecureSkipVerify Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
} `json:"tlsConfig,omitempty"`
}
// UpdateJSONBodyMetricsRelabelConfigsAction defines parameters for Update.
type UpdateJSONBodyMetricsRelabelConfigsAction string
// UpdateJSONBodyScheme defines parameters for Update.
type UpdateJSONBodyScheme string
// PartialUpdateJSONRequestBody defines body for PartialUpdate for application/json ContentType.
type PartialUpdateJSONRequestBody = PartialUpdateJSONBody
// CreateJSONRequestBody defines body for Create for application/json ContentType.
type CreateJSONRequestBody CreateJSONBody
// UpdateJSONRequestBody defines body for Update for application/json ContentType.
type UpdateJSONRequestBody UpdateJSONBody
// RequestEditorFn is the function signature for the RequestEditor callback function
type RequestEditorFn func(ctx context.Context, req *http.Request) error
// Client which conforms to the OpenAPI3 specification for this service.
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client common.Client
}
// Creates a new Client, with reasonable defaults
func NewClient(server string, httpClient common.Client) *Client {
// create a client with sane default values
client := Client{
Server: server,
Client: httpClient,
}
return &client
}
// The interface specification for the client above.
type ClientInterface interface {
// Delete request
Delete(ctx context.Context, projectID string, instanceID string, params *DeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// List request
List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)
// PartialUpdate request with any body
PartialUpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PartialUpdate(ctx context.Context, projectID string, instanceID string, body PartialUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// Create request with any body
CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
Create(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteConfigs request
DeleteConfigs(ctx context.Context, projectID string, instanceID string, jobName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// Read request
Read(ctx context.Context, projectID string, instanceID string, jobName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// Update request with any body
UpdateWithBody(ctx context.Context, projectID string, instanceID string, jobName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
Update(ctx context.Context, projectID string, instanceID string, jobName string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
func (c *Client) Delete(ctx context.Context, projectID string, instanceID string, params *DeleteParams, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewDeleteRequest(ctx, c.Server, projectID, instanceID, params)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewListRequest(ctx, c.Server, projectID, instanceID)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) PartialUpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewPartialUpdateRequestWithBody(ctx, c.Server, projectID, instanceID, contentType, body)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) PartialUpdate(ctx context.Context, projectID string, instanceID string, body PartialUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewPartialUpdateRequest(ctx, c.Server, projectID, instanceID, body)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewCreateRequestWithBody(ctx, c.Server, projectID, instanceID, contentType, body)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) Create(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewCreateRequest(ctx, c.Server, projectID, instanceID, body)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) DeleteConfigs(ctx context.Context, projectID string, instanceID string, jobName string, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewDeleteConfigsRequest(ctx, c.Server, projectID, instanceID, jobName)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) Read(ctx context.Context, projectID string, instanceID string, jobName string, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewReadRequest(ctx, c.Server, projectID, instanceID, jobName)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) UpdateWithBody(ctx context.Context, projectID string, instanceID string, jobName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewUpdateRequestWithBody(ctx, c.Server, projectID, instanceID, jobName, contentType, body)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) Update(ctx context.Context, projectID string, instanceID string, jobName string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewUpdateRequest(ctx, c.Server, projectID, instanceID, jobName, body)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
// NewDeleteRequest generates requests for Delete
func NewDeleteRequest(ctx context.Context, server string, projectID string, instanceID string, params *DeleteParams) (*http.Request, error) {
var err error
var pathParam0 string
pathParam0, err = runtime.StyleParamWithLocation("simple", false, "projectID", runtime.ParamLocationPath, projectID)
if err != nil {
return nil, err
}
var pathParam1 string
pathParam1, err = runtime.StyleParamWithLocation("simple", false, "instanceID", runtime.ParamLocationPath, instanceID)
if err != nil {
return nil, err
}
serverURL, err := url.Parse(server)
if err != nil {
return nil, err
}
operationPath := fmt.Sprintf("/v1/projects/%s/instances/%s/scrapeconfigs", pathParam0, pathParam1)
if operationPath[0] == '/' {
operationPath = "." + operationPath
}
queryURL, err := serverURL.Parse(operationPath)
if err != nil {
return nil, err
}
queryValues := queryURL.Query()
if queryFrag, err := runtime.StyleParamWithLocation("form", false, "jobName", runtime.ParamLocationQuery, params.JobName); err != nil {
return nil, err
} else if parsed, err := url.ParseQuery(queryFrag); err != nil {
return nil, err
} else {
for k, v := range parsed {
for _, v2 := range v {
queryValues.Add(k, v2)
}
}
}
queryURL.RawQuery = queryValues.Encode()
req, err := http.NewRequestWithContext(ctx, "DELETE", queryURL.String(), nil)
if err != nil {
return nil, err
}
return req, nil
}
// NewListRequest generates requests for List
func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error) {
var err error
var pathParam0 string
pathParam0, err = runtime.StyleParamWithLocation("simple", false, "projectID", runtime.ParamLocationPath, projectID)
if err != nil {
return nil, err
}
var pathParam1 string
pathParam1, err = runtime.StyleParamWithLocation("simple", false, "instanceID", runtime.ParamLocationPath, instanceID)
if err != nil {
return nil, err
}
serverURL, err := url.Parse(server)
if err != nil {
return nil, err
}
operationPath := fmt.Sprintf("/v1/projects/%s/instances/%s/scrapeconfigs", pathParam0, pathParam1)
if operationPath[0] == '/' {
operationPath = "." + operationPath
}
queryURL, err := serverURL.Parse(operationPath)
if err != nil {
return nil, err
}
req, err := http.NewRequestWithContext(ctx, "GET", queryURL.String(), nil)
if err != nil {
return nil, err
}
return req, nil
}
// NewPartialUpdateRequest calls the generic PartialUpdate builder with application/json body
func NewPartialUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, body PartialUpdateJSONRequestBody) (*http.Request, error) {
var bodyReader io.Reader
buf, err := json.Marshal(body)
if err != nil {
return nil, err
}
bodyReader = bytes.NewReader(buf)
return NewPartialUpdateRequestWithBody(ctx, server, projectID, instanceID, "application/json", bodyReader)
}
// NewPartialUpdateRequestWithBody generates requests for PartialUpdate with any type of body
func NewPartialUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error) {
var err error
var pathParam0 string
pathParam0, err = runtime.StyleParamWithLocation("simple", false, "projectID", runtime.ParamLocationPath, projectID)
if err != nil {
return nil, err
}
var pathParam1 string
pathParam1, err = runtime.StyleParamWithLocation("simple", false, "instanceID", runtime.ParamLocationPath, instanceID)
if err != nil {
return nil, err
}
serverURL, err := url.Parse(server)
if err != nil {
return nil, err
}
operationPath := fmt.Sprintf("/v1/projects/%s/instances/%s/scrapeconfigs", pathParam0, pathParam1)
if operationPath[0] == '/' {
operationPath = "." + operationPath
}
queryURL, err := serverURL.Parse(operationPath)
if err != nil {
return nil, err
}
req, err := http.NewRequestWithContext(ctx, "PATCH", queryURL.String(), body)
if err != nil {
return nil, err