-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathapi_metrics.rs
More file actions
4228 lines (3891 loc) · 178 KB
/
Copy pathapi_metrics.rs
File metadata and controls
4228 lines (3891 loc) · 178 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
// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2019-Present Datadog, Inc.
use crate::datadog;
use async_stream::try_stream;
use flate2::{
write::{GzEncoder, ZlibEncoder},
Compression,
};
use futures_core::stream::Stream;
use reqwest::header::{HeaderMap, HeaderValue};
use serde::{Deserialize, Serialize};
use std::io::Write;
/// EstimateMetricsOutputSeriesOptionalParams is a struct for passing parameters to the method [`MetricsAPI::estimate_metrics_output_series`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct EstimateMetricsOutputSeriesOptionalParams {
/// Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
pub filter_groups: Option<String>,
/// The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
pub filter_hours_ago: Option<i32>,
/// Deprecated. Number of aggregations has no impact on volume.
pub filter_num_aggregations: Option<i32>,
/// A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
pub filter_pct: Option<bool>,
/// A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.
pub filter_timespan_h: Option<i32>,
}
impl EstimateMetricsOutputSeriesOptionalParams {
/// Comma-separated list of tag keys that the metric is configured to query with. For example: `filter[groups]=app,host`.
pub fn filter_groups(mut self, value: String) -> Self {
self.filter_groups = Some(value);
self
}
/// The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.
pub fn filter_hours_ago(mut self, value: i32) -> Self {
self.filter_hours_ago = Some(value);
self
}
/// Deprecated. Number of aggregations has no impact on volume.
pub fn filter_num_aggregations(mut self, value: i32) -> Self {
self.filter_num_aggregations = Some(value);
self
}
/// A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
pub fn filter_pct(mut self, value: bool) -> Self {
self.filter_pct = Some(value);
self
}
/// A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.
pub fn filter_timespan_h(mut self, value: i32) -> Self {
self.filter_timespan_h = Some(value);
self
}
}
/// ListActiveMetricConfigurationsOptionalParams is a struct for passing parameters to the method [`MetricsAPI::list_active_metric_configurations`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct ListActiveMetricConfigurationsOptionalParams {
/// The number of seconds of look back (from now).
/// Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month).
pub window_seconds: Option<i64>,
}
impl ListActiveMetricConfigurationsOptionalParams {
/// The number of seconds of look back (from now).
/// Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month).
pub fn window_seconds(mut self, value: i64) -> Self {
self.window_seconds = Some(value);
self
}
}
/// ListTagConfigurationsOptionalParams is a struct for passing parameters to the method [`MetricsAPI::list_tag_configurations`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct ListTagConfigurationsOptionalParams {
/// Only return custom metrics that have been configured with Metrics Without Limits.
pub filter_configured: Option<bool>,
/// Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
pub filter_tags_configured: Option<String>,
/// Only return metrics of the given metric type.
pub filter_metric_type:
Option<crate::datadogV2::model::MetricTagConfigurationMetricTypeCategory>,
/// Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
pub filter_include_percentiles: Option<bool>,
/// Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with `filter[queried][window][seconds]`; if omitted, a default window is used.
pub filter_queried: Option<bool>,
/// This parameter has no effect unless `filter[queried]` is also set. Only return metrics that have been queried or not queried in the specified window. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second. For example: `filter[queried]=true&filter[queried][window][seconds]=604800`.
pub filter_queried_window_seconds: Option<i64>,
/// Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards. For example: `filter[tags]=env IN (staging,test) AND service:web*`.
pub filter_tags: Option<String>,
/// Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
pub filter_related_assets: Option<bool>,
/// Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
pub window_seconds: Option<i64>,
/// Maximum number of results per page. Send `page[size]` on the first request to opt in to pagination. On each subsequent request, send `page[cursor]` set to the value of `meta.pagination.next_cursor` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
pub page_size: Option<i32>,
/// Cursor for pagination. Use `page[size]` to opt-in to pagination and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor` in the response. Pagination is complete when `next_cursor` is null.
pub page_cursor: Option<String>,
}
impl ListTagConfigurationsOptionalParams {
/// Only return custom metrics that have been configured with Metrics Without Limits.
pub fn filter_configured(mut self, value: bool) -> Self {
self.filter_configured = Some(value);
self
}
/// Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
pub fn filter_tags_configured(mut self, value: String) -> Self {
self.filter_tags_configured = Some(value);
self
}
/// Only return metrics of the given metric type.
pub fn filter_metric_type(
mut self,
value: crate::datadogV2::model::MetricTagConfigurationMetricTypeCategory,
) -> Self {
self.filter_metric_type = Some(value);
self
}
/// Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
pub fn filter_include_percentiles(mut self, value: bool) -> Self {
self.filter_include_percentiles = Some(value);
self
}
/// Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with `filter[queried][window][seconds]`; if omitted, a default window is used.
pub fn filter_queried(mut self, value: bool) -> Self {
self.filter_queried = Some(value);
self
}
/// This parameter has no effect unless `filter[queried]` is also set. Only return metrics that have been queried or not queried in the specified window. The default value is 2,592,000 seconds (30 days), the maximum value is 15,552,000 seconds (180 days), and the minimum value is 1 second. For example: `filter[queried]=true&filter[queried][window][seconds]=604800`.
pub fn filter_queried_window_seconds(mut self, value: i64) -> Self {
self.filter_queried_window_seconds = Some(value);
self
}
/// Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards. For example: `filter[tags]=env IN (staging,test) AND service:web*`.
pub fn filter_tags(mut self, value: String) -> Self {
self.filter_tags = Some(value);
self
}
/// Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
pub fn filter_related_assets(mut self, value: bool) -> Self {
self.filter_related_assets = Some(value);
self
}
/// Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
pub fn window_seconds(mut self, value: i64) -> Self {
self.window_seconds = Some(value);
self
}
/// Maximum number of results per page. Send `page[size]` on the first request to opt in to pagination. On each subsequent request, send `page[cursor]` set to the value of `meta.pagination.next_cursor` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
pub fn page_size(mut self, value: i32) -> Self {
self.page_size = Some(value);
self
}
/// Cursor for pagination. Use `page[size]` to opt-in to pagination and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor` in the response. Pagination is complete when `next_cursor` is null.
pub fn page_cursor(mut self, value: String) -> Self {
self.page_cursor = Some(value);
self
}
}
/// ListTagIndexingRulesOptionalParams is a struct for passing parameters to the method [`MetricsAPI::list_tag_indexing_rules`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct ListTagIndexingRulesOptionalParams {
/// Page size (1–1000, default 100).
pub page_limit: Option<i64>,
/// Page offset from the start of the list (default 0).
pub page_offset: Option<i64>,
/// Substring filter on rule name.
pub search: Option<String>,
}
impl ListTagIndexingRulesOptionalParams {
/// Page size (1–1000, default 100).
pub fn page_limit(mut self, value: i64) -> Self {
self.page_limit = Some(value);
self
}
/// Page offset from the start of the list (default 0).
pub fn page_offset(mut self, value: i64) -> Self {
self.page_offset = Some(value);
self
}
/// Substring filter on rule name.
pub fn search(mut self, value: String) -> Self {
self.search = Some(value);
self
}
}
/// ListTagsByMetricNameOptionalParams is a struct for passing parameters to the method [`MetricsAPI::list_tags_by_metric_name`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct ListTagsByMetricNameOptionalParams {
/// The number of seconds of look back (from now) to query for tag data.
/// Default value is 14400 (4 hours), minimum value is 14400 (4 hours).
pub window_seconds: Option<i64>,
/// Filter results to tags from data points that have the specified tags.
/// For example, `filter[tags]=env:staging,host:123` returns tags only from data points with both `env:staging` and `host:123`.
pub filter_tags: Option<String>,
/// Filter returned tags to those matching a substring.
/// For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`, etc.
pub filter_match: Option<String>,
/// Whether to include tag values in the response.
/// Defaults to true.
pub filter_include_tag_values: Option<bool>,
/// Whether to allow partial results.
/// Defaults to false.
pub filter_allow_partial: Option<bool>,
/// Maximum number of results to return.
pub page_limit: Option<i32>,
}
impl ListTagsByMetricNameOptionalParams {
/// The number of seconds of look back (from now) to query for tag data.
/// Default value is 14400 (4 hours), minimum value is 14400 (4 hours).
pub fn window_seconds(mut self, value: i64) -> Self {
self.window_seconds = Some(value);
self
}
/// Filter results to tags from data points that have the specified tags.
/// For example, `filter[tags]=env:staging,host:123` returns tags only from data points with both `env:staging` and `host:123`.
pub fn filter_tags(mut self, value: String) -> Self {
self.filter_tags = Some(value);
self
}
/// Filter returned tags to those matching a substring.
/// For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`, etc.
pub fn filter_match(mut self, value: String) -> Self {
self.filter_match = Some(value);
self
}
/// Whether to include tag values in the response.
/// Defaults to true.
pub fn filter_include_tag_values(mut self, value: bool) -> Self {
self.filter_include_tag_values = Some(value);
self
}
/// Whether to allow partial results.
/// Defaults to false.
pub fn filter_allow_partial(mut self, value: bool) -> Self {
self.filter_allow_partial = Some(value);
self
}
/// Maximum number of results to return.
pub fn page_limit(mut self, value: i32) -> Self {
self.page_limit = Some(value);
self
}
}
/// ListVolumesByMetricNameOptionalParams is a struct for passing parameters to the method [`MetricsAPI::list_volumes_by_metric_name`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct ListVolumesByMetricNameOptionalParams {
/// The number of seconds of look back (from now).
/// Default value is 3,600 (1 hour), maximum value is 2,592,000 (1 month).
pub window_seconds: Option<i64>,
}
impl ListVolumesByMetricNameOptionalParams {
/// The number of seconds of look back (from now).
/// Default value is 3,600 (1 hour), maximum value is 2,592,000 (1 month).
pub fn window_seconds(mut self, value: i64) -> Self {
self.window_seconds = Some(value);
self
}
}
/// SubmitMetricsOptionalParams is a struct for passing parameters to the method [`MetricsAPI::submit_metrics`]
#[non_exhaustive]
#[derive(Clone, Default, Debug)]
pub struct SubmitMetricsOptionalParams {
/// HTTP header used to compress the media-type.
pub content_encoding: Option<crate::datadogV2::model::MetricContentEncoding>,
}
impl SubmitMetricsOptionalParams {
/// HTTP header used to compress the media-type.
pub fn content_encoding(
mut self,
value: crate::datadogV2::model::MetricContentEncoding,
) -> Self {
self.content_encoding = Some(value);
self
}
}
/// CreateBulkTagsMetricsConfigurationError is a struct for typed errors of method [`MetricsAPI::create_bulk_tags_metrics_configuration`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CreateBulkTagsMetricsConfigurationError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// CreateTagConfigurationError is a struct for typed errors of method [`MetricsAPI::create_tag_configuration`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CreateTagConfigurationError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// CreateTagIndexingRuleError is a struct for typed errors of method [`MetricsAPI::create_tag_indexing_rule`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CreateTagIndexingRuleError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// CreateTagIndexingRuleExemptionError is a struct for typed errors of method [`MetricsAPI::create_tag_indexing_rule_exemption`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CreateTagIndexingRuleExemptionError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// DeleteBulkTagsMetricsConfigurationError is a struct for typed errors of method [`MetricsAPI::delete_bulk_tags_metrics_configuration`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum DeleteBulkTagsMetricsConfigurationError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// DeleteTagConfigurationError is a struct for typed errors of method [`MetricsAPI::delete_tag_configuration`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum DeleteTagConfigurationError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// DeleteTagIndexingRuleError is a struct for typed errors of method [`MetricsAPI::delete_tag_indexing_rule`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum DeleteTagIndexingRuleError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// DeleteTagIndexingRuleExemptionError is a struct for typed errors of method [`MetricsAPI::delete_tag_indexing_rule_exemption`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum DeleteTagIndexingRuleExemptionError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// EstimateMetricsOutputSeriesError is a struct for typed errors of method [`MetricsAPI::estimate_metrics_output_series`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum EstimateMetricsOutputSeriesError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// GetMetricTagCardinalityDetailsError is a struct for typed errors of method [`MetricsAPI::get_metric_tag_cardinality_details`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum GetMetricTagCardinalityDetailsError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// GetTagIndexingRuleError is a struct for typed errors of method [`MetricsAPI::get_tag_indexing_rule`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum GetTagIndexingRuleError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// GetTagIndexingRuleExemptionError is a struct for typed errors of method [`MetricsAPI::get_tag_indexing_rule_exemption`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum GetTagIndexingRuleExemptionError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListActiveMetricConfigurationsError is a struct for typed errors of method [`MetricsAPI::list_active_metric_configurations`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListActiveMetricConfigurationsError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListMetricAssetsError is a struct for typed errors of method [`MetricsAPI::list_metric_assets`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListMetricAssetsError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListTagConfigurationByNameError is a struct for typed errors of method [`MetricsAPI::list_tag_configuration_by_name`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListTagConfigurationByNameError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListTagConfigurationsError is a struct for typed errors of method [`MetricsAPI::list_tag_configurations`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListTagConfigurationsError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListTagIndexingRulesError is a struct for typed errors of method [`MetricsAPI::list_tag_indexing_rules`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListTagIndexingRulesError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListTagIndexingRulesForMetricError is a struct for typed errors of method [`MetricsAPI::list_tag_indexing_rules_for_metric`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListTagIndexingRulesForMetricError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListTagsByMetricNameError is a struct for typed errors of method [`MetricsAPI::list_tags_by_metric_name`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListTagsByMetricNameError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ListVolumesByMetricNameError is a struct for typed errors of method [`MetricsAPI::list_volumes_by_metric_name`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ListVolumesByMetricNameError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// QueryScalarDataError is a struct for typed errors of method [`MetricsAPI::query_scalar_data`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum QueryScalarDataError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// QueryTimeseriesDataError is a struct for typed errors of method [`MetricsAPI::query_timeseries_data`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum QueryTimeseriesDataError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// ReorderTagIndexingRulesError is a struct for typed errors of method [`MetricsAPI::reorder_tag_indexing_rules`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ReorderTagIndexingRulesError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// SubmitMetricsError is a struct for typed errors of method [`MetricsAPI::submit_metrics`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum SubmitMetricsError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// UpdateTagConfigurationError is a struct for typed errors of method [`MetricsAPI::update_tag_configuration`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum UpdateTagConfigurationError {
APIErrorResponse(crate::datadogV2::model::APIErrorResponse),
UnknownValue(serde_json::Value),
}
/// UpdateTagIndexingRuleError is a struct for typed errors of method [`MetricsAPI::update_tag_indexing_rule`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum UpdateTagIndexingRuleError {
JSONAPIErrorResponse(crate::datadogV2::model::JSONAPIErrorResponse),
UnknownValue(serde_json::Value),
}
/// The metrics endpoint allows you to:
///
/// - Post metrics data so it can be graphed on Datadog’s dashboards
/// - Query metrics from any time period (timeseries and scalar)
/// - Modify tag configurations for metrics
/// - View tags and volumes for metrics
///
/// **Note**: A graph can only contain a set number of points
/// and as the timeframe over which a metric is viewed increases,
/// aggregation between points occurs to stay below that set number.
///
/// The Post, Patch, and Delete `manage_tags` API methods can only be performed by
/// a user who has the `Manage Tags for Metrics` permission.
///
/// See the [Metrics page](<https://docs.datadoghq.com/metrics/>) for more information.
#[derive(Debug, Clone)]
pub struct MetricsAPI {
config: datadog::Configuration,
client: reqwest_middleware::ClientWithMiddleware,
}
impl Default for MetricsAPI {
fn default() -> Self {
Self::with_config(datadog::Configuration::default())
}
}
impl MetricsAPI {
pub fn new() -> Self {
Self::default()
}
pub fn with_config(config: datadog::Configuration) -> Self {
let reqwest_client_builder = {
let builder = reqwest::Client::builder();
#[cfg(not(target_arch = "wasm32"))]
let builder = if let Some(proxy_url) = &config.proxy_url {
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
} else {
builder
};
builder
};
let middleware_client_builder = {
let builder =
reqwest_middleware::ClientBuilder::new(reqwest_client_builder.build().unwrap());
#[cfg(feature = "retry")]
let builder = if config.enable_retry {
struct RetryableStatus;
impl reqwest_retry::RetryableStrategy for RetryableStatus {
fn handle(
&self,
res: &Result<reqwest::Response, reqwest_middleware::Error>,
) -> Option<reqwest_retry::Retryable> {
match res {
Ok(success) => reqwest_retry::default_on_request_success(success),
Err(_) => None,
}
}
}
let backoff_policy = reqwest_retry::policies::ExponentialBackoff::builder()
.build_with_max_retries(config.max_retries);
let retry_middleware =
reqwest_retry::RetryTransientMiddleware::new_with_policy_and_strategy(
backoff_policy,
RetryableStatus,
);
builder.with(retry_middleware)
} else {
builder
};
builder
};
let client = middleware_client_builder.build();
Self { config, client }
}
pub fn with_client_and_config(
config: datadog::Configuration,
client: reqwest_middleware::ClientWithMiddleware,
) -> Self {
Self { config, client }
}
/// **Note**: This endpoint is deprecated. Use [Tag Indexing Rules](/api/latest/metrics/#create-a-tag-indexing-rule) (`POST /api/v2/metrics/tag-indexing-rules`) instead.
///
/// Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
/// Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
/// Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
/// If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
/// expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to
/// the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
/// Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
pub async fn create_bulk_tags_metrics_configuration(
&self,
body: crate::datadogV2::model::MetricBulkTagConfigCreateRequest,
) -> Result<
crate::datadogV2::model::MetricBulkTagConfigResponse,
datadog::Error<CreateBulkTagsMetricsConfigurationError>,
> {
match self
.create_bulk_tags_metrics_configuration_with_http_info(body)
.await
{
Ok(response_content) => {
if let Some(e) = response_content.entity {
Ok(e)
} else {
Err(datadog::Error::Serde(serde::de::Error::custom(
"response content was None",
)))
}
}
Err(err) => Err(err),
}
}
/// **Note**: This endpoint is deprecated. Use [Tag Indexing Rules](/api/latest/metrics/#create-a-tag-indexing-rule) (`POST /api/v2/metrics/tag-indexing-rules`) instead.
///
/// Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
/// Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
/// Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
/// If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
/// expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to
/// the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric.
/// Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
pub async fn create_bulk_tags_metrics_configuration_with_http_info(
&self,
body: crate::datadogV2::model::MetricBulkTagConfigCreateRequest,
) -> Result<
datadog::ResponseContent<crate::datadogV2::model::MetricBulkTagConfigResponse>,
datadog::Error<CreateBulkTagsMetricsConfigurationError>,
> {
let local_configuration = &self.config;
let operation_id = "v2.create_bulk_tags_metrics_configuration";
let local_client = &self.client;
let local_uri_str = format!(
"{}/api/v2/metrics/config/bulk-tags",
local_configuration.get_operation_host(operation_id)
);
let mut local_req_builder =
local_client.request(reqwest::Method::POST, local_uri_str.as_str());
// build headers
let mut headers = HeaderMap::new();
headers.insert("Content-Type", HeaderValue::from_static("application/json"));
headers.insert("Accept", HeaderValue::from_static("application/json"));
// build user agent
match HeaderValue::from_str(local_configuration.user_agent.as_str()) {
Ok(user_agent) => headers.insert(reqwest::header::USER_AGENT, user_agent),
Err(e) => {
log::warn!("Failed to parse user agent header: {e}, falling back to default");
headers.insert(
reqwest::header::USER_AGENT,
HeaderValue::from_static(datadog::DEFAULT_USER_AGENT.as_str()),
)
}
};
// build auth
if let Some(local_key) = local_configuration.auth_keys.get("apiKeyAuth") {
headers.insert(
"DD-API-KEY",
HeaderValue::from_str(local_key.key.as_str())
.expect("failed to parse DD-API-KEY header"),
);
};
if let Some(local_key) = local_configuration.auth_keys.get("appKeyAuth") {
headers.insert(
"DD-APPLICATION-KEY",
HeaderValue::from_str(local_key.key.as_str())
.expect("failed to parse DD-APPLICATION-KEY header"),
);
};
// build body parameters
let output = Vec::new();
let mut ser = serde_json::Serializer::with_formatter(output, datadog::DDFormatter);
if body.serialize(&mut ser).is_ok() {
if let Some(content_encoding) = headers.get("Content-Encoding") {
match content_encoding.to_str().unwrap_or_default() {
"gzip" => {
let mut enc = GzEncoder::new(Vec::new(), Compression::default());
let _ = enc.write_all(ser.into_inner().as_slice());
match enc.finish() {
Ok(buf) => {
local_req_builder = local_req_builder.body(buf);
}
Err(e) => return Err(datadog::Error::Io(e)),
}
}
"deflate" => {
let mut enc = ZlibEncoder::new(Vec::new(), Compression::default());
let _ = enc.write_all(ser.into_inner().as_slice());
match enc.finish() {
Ok(buf) => {
local_req_builder = local_req_builder.body(buf);
}
Err(e) => return Err(datadog::Error::Io(e)),
}
}
#[cfg(feature = "zstd")]
"zstd1" => {
let mut enc = zstd::stream::Encoder::new(Vec::new(), 0).unwrap();
let _ = enc.write_all(ser.into_inner().as_slice());
match enc.finish() {
Ok(buf) => {
local_req_builder = local_req_builder.body(buf);
}
Err(e) => return Err(datadog::Error::Io(e)),
}
}
_ => {
local_req_builder = local_req_builder.body(ser.into_inner());
}
}
} else {
local_req_builder = local_req_builder.body(ser.into_inner());
}
}
local_req_builder = local_req_builder.headers(headers);
let local_req = local_req_builder.build()?;
log::debug!("request content: {:?}", local_req.body());
let local_resp = local_client.execute(local_req).await?;
let local_status = local_resp.status();
let local_content = local_resp.text().await?;
log::debug!("response content: {}", local_content);
if !local_status.is_client_error() && !local_status.is_server_error() {
match serde_json::from_str::<crate::datadogV2::model::MetricBulkTagConfigResponse>(
&local_content,
) {
Ok(e) => {
return Ok(datadog::ResponseContent {
status: local_status,
content: local_content,
entity: Some(e),
})
}
Err(e) => return Err(datadog::Error::Serde(e)),
};
} else {
let local_entity: Option<CreateBulkTagsMetricsConfigurationError> =
serde_json::from_str(&local_content).ok();
let local_error = datadog::ResponseContent {
status: local_status,
content: local_content,
entity: local_entity,
};
Err(datadog::Error::ResponseError(local_error))
}
}
/// Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
/// Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`
/// to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
/// not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`
/// permission.
pub async fn create_tag_configuration(
&self,
metric_name: String,
body: crate::datadogV2::model::MetricTagConfigurationCreateRequest,
) -> Result<
crate::datadogV2::model::MetricTagConfigurationResponse,
datadog::Error<CreateTagConfigurationError>,
> {
match self
.create_tag_configuration_with_http_info(metric_name, body)
.await
{
Ok(response_content) => {
if let Some(e) = response_content.entity {
Ok(e)
} else {
Err(datadog::Error::Serde(serde::de::Error::custom(
"response content was None",
)))
}
}
Err(err) => Err(err),
}
}
/// Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
/// Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`
/// to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
/// not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`
/// permission.
pub async fn create_tag_configuration_with_http_info(
&self,
metric_name: String,
body: crate::datadogV2::model::MetricTagConfigurationCreateRequest,
) -> Result<
datadog::ResponseContent<crate::datadogV2::model::MetricTagConfigurationResponse>,
datadog::Error<CreateTagConfigurationError>,
> {
let local_configuration = &self.config;
let operation_id = "v2.create_tag_configuration";
let local_client = &self.client;
let local_uri_str = format!(
"{}/api/v2/metrics/{metric_name}/tags",
local_configuration.get_operation_host(operation_id),
metric_name = datadog::urlencode(metric_name)
);
let mut local_req_builder =
local_client.request(reqwest::Method::POST, local_uri_str.as_str());
// build headers
let mut headers = HeaderMap::new();
headers.insert("Content-Type", HeaderValue::from_static("application/json"));
headers.insert("Accept", HeaderValue::from_static("application/json"));
// build user agent
match HeaderValue::from_str(local_configuration.user_agent.as_str()) {
Ok(user_agent) => headers.insert(reqwest::header::USER_AGENT, user_agent),
Err(e) => {
log::warn!("Failed to parse user agent header: {e}, falling back to default");
headers.insert(
reqwest::header::USER_AGENT,
HeaderValue::from_static(datadog::DEFAULT_USER_AGENT.as_str()),
)
}
};
// build auth
if let Some(local_key) = local_configuration.auth_keys.get("apiKeyAuth") {
headers.insert(
"DD-API-KEY",
HeaderValue::from_str(local_key.key.as_str())
.expect("failed to parse DD-API-KEY header"),
);
};
if let Some(local_key) = local_configuration.auth_keys.get("appKeyAuth") {
headers.insert(
"DD-APPLICATION-KEY",
HeaderValue::from_str(local_key.key.as_str())
.expect("failed to parse DD-APPLICATION-KEY header"),
);
};
// build body parameters
let output = Vec::new();
let mut ser = serde_json::Serializer::with_formatter(output, datadog::DDFormatter);
if body.serialize(&mut ser).is_ok() {
if let Some(content_encoding) = headers.get("Content-Encoding") {
match content_encoding.to_str().unwrap_or_default() {
"gzip" => {
let mut enc = GzEncoder::new(Vec::new(), Compression::default());
let _ = enc.write_all(ser.into_inner().as_slice());
match enc.finish() {
Ok(buf) => {
local_req_builder = local_req_builder.body(buf);
}
Err(e) => return Err(datadog::Error::Io(e)),
}
}
"deflate" => {
let mut enc = ZlibEncoder::new(Vec::new(), Compression::default());
let _ = enc.write_all(ser.into_inner().as_slice());
match enc.finish() {
Ok(buf) => {
local_req_builder = local_req_builder.body(buf);
}
Err(e) => return Err(datadog::Error::Io(e)),
}
}
#[cfg(feature = "zstd")]
"zstd1" => {
let mut enc = zstd::stream::Encoder::new(Vec::new(), 0).unwrap();
let _ = enc.write_all(ser.into_inner().as_slice());
match enc.finish() {
Ok(buf) => {
local_req_builder = local_req_builder.body(buf);
}
Err(e) => return Err(datadog::Error::Io(e)),
}
}
_ => {
local_req_builder = local_req_builder.body(ser.into_inner());
}
}
} else {
local_req_builder = local_req_builder.body(ser.into_inner());
}
}
local_req_builder = local_req_builder.headers(headers);
let local_req = local_req_builder.build()?;
log::debug!("request content: {:?}", local_req.body());
let local_resp = local_client.execute(local_req).await?;
let local_status = local_resp.status();
let local_content = local_resp.text().await?;
log::debug!("response content: {}", local_content);
if !local_status.is_client_error() && !local_status.is_server_error() {
match serde_json::from_str::<crate::datadogV2::model::MetricTagConfigurationResponse>(
&local_content,
) {
Ok(e) => {
return Ok(datadog::ResponseContent {
status: local_status,
content: local_content,
entity: Some(e),
})
}
Err(e) => return Err(datadog::Error::Serde(e)),
};
} else {
let local_entity: Option<CreateTagConfigurationError> =
serde_json::from_str(&local_content).ok();
let local_error = datadog::ResponseContent {
status: local_status,
content: local_content,
entity: local_entity,
};
Err(datadog::Error::ResponseError(local_error))
}
}
/// Create a tag indexing rule for the org. `rule_order` is assigned server-side as max+1
/// among existing rules; use the reorder endpoint to change the evaluation order.
/// Requires the `Manage Tags for Metrics` permission.
pub async fn create_tag_indexing_rule(
&self,
body: crate::datadogV2::model::TagIndexingRuleCreateRequest,
) -> Result<
crate::datadogV2::model::TagIndexingRuleResponse,
datadog::Error<CreateTagIndexingRuleError>,
> {
match self.create_tag_indexing_rule_with_http_info(body).await {
Ok(response_content) => {
if let Some(e) = response_content.entity {
Ok(e)
} else {
Err(datadog::Error::Serde(serde::de::Error::custom(
"response content was None",
)))
}
}
Err(err) => Err(err),
}
}
/// Create a tag indexing rule for the org. `rule_order` is assigned server-side as max+1
/// among existing rules; use the reorder endpoint to change the evaluation order.
/// Requires the `Manage Tags for Metrics` permission.
pub async fn create_tag_indexing_rule_with_http_info(
&self,
body: crate::datadogV2::model::TagIndexingRuleCreateRequest,
) -> Result<
datadog::ResponseContent<crate::datadogV2::model::TagIndexingRuleResponse>,
datadog::Error<CreateTagIndexingRuleError>,
> {
let local_configuration = &self.config;
let operation_id = "v2.create_tag_indexing_rule";
let local_client = &self.client;
let local_uri_str = format!(
"{}/api/v2/metrics/tag-indexing-rules",
local_configuration.get_operation_host(operation_id)
);
let mut local_req_builder =
local_client.request(reqwest::Method::POST, local_uri_str.as_str());
// build headers
let mut headers = HeaderMap::new();
headers.insert("Content-Type", HeaderValue::from_static("application/json"));
headers.insert("Accept", HeaderValue::from_static("application/json"));
// build user agent
match HeaderValue::from_str(local_configuration.user_agent.as_str()) {
Ok(user_agent) => headers.insert(reqwest::header::USER_AGENT, user_agent),
Err(e) => {
log::warn!("Failed to parse user agent header: {e}, falling back to default");
headers.insert(
reqwest::header::USER_AGENT,
HeaderValue::from_static(datadog::DEFAULT_USER_AGENT.as_str()),
)
}
};
// build auth
if let Some(local_key) = local_configuration.auth_keys.get("apiKeyAuth") {
headers.insert(
"DD-API-KEY",