You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
6748
-
Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
6749
-
on any count, rate, or gauge metric. By setting <code class="docutils literal notranslate"><span class="pre">exclude_tags_mode</span></code> to true the behavior is changed
6750
-
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
6751
-
Can only be used with application keys of users with the <code class="docutils literal notranslate"><span class="pre">Manage</span> <span class="pre">Tags</span> <span class="pre">for</span> <span class="pre">Metrics</span></code> permission.</p>
6748
+
Optionally, include percentile aggregations on any distribution metric. By setting <code class="docutils literal notranslate"><span class="pre">exclude_tags_mode</span></code>
6749
+
to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
6750
+
not queryable. Can only be used with application keys of users with the <code class="docutils literal notranslate"><span class="pre">Manage</span> <span class="pre">Tags</span> <span class="pre">for</span> <span class="pre">Metrics</span></code>
<li><p><strong>metric_name</strong> (<em>str</em>) – The name of the metric.</p></li>
6799
6799
<li><p><strong>filter_groups</strong> (<em>str</em><em>, </em><em>optional</em>) – Filtered tag keys that the metric is configured to query with.</p></li>
6800
6800
<li><p><strong>filter_hours_ago</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.</p></li>
6801
-
<li><p><strong>filter_num_aggregations</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of aggregations that a <code class="docutils literal notranslate"><span class="pre">count</span></code> , <code class="docutils literal notranslate"><span class="pre">rate</span></code> , or <code class="docutils literal notranslate"><span class="pre">gauge</span></code> metric is configured to use. Max number of aggregation combos is 9.</p></li>
6801
+
<li><p><strong>filter_num_aggregations</strong> (<em>int</em><em>, </em><em>optional</em>) – Deprecated. Number of aggregations has no impact on volume.</p></li>
6802
6802
<li><p><strong>filter_pct</strong> (<em>bool</em><em>, </em><em>optional</em>) – A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.</p></li>
6803
6803
<li><p><strong>filter_timespan_h</strong> (<em>int</em><em>, </em><em>optional</em>) – A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.</p></li>
<dt>A list of queryable aggregation combinations for a count, rate, or gauge metric.</dt><dd><p>By default, count and rate metrics require the (time: sum, space: sum) aggregation and
45973
-
Gauge metrics require the (time: avg, space: avg) aggregation.
45974
-
Additional time & space combinations are also available:</p>
45975
-
<ul class="simple">
45976
-
<li><p>time: avg, space: avg</p></li>
45977
-
<li><p>time: avg, space: max</p></li>
45978
-
<li><p>time: avg, space: min</p></li>
45979
-
<li><p>time: avg, space: sum</p></li>
45980
-
<li><p>time: count, space: sum</p></li>
45981
-
<li><p>time: max, space: max</p></li>
45982
-
<li><p>time: min, space: min</p></li>
45983
-
<li><p>time: sum, space: avg</p></li>
45984
-
<li><p>time: sum, space: sum</p></li>
45985
-
</ul>
45986
-
<p>Can only be applied to non_distribution metrics that have a <code class="docutils literal notranslate"><span class="pre">metric_type</span></code> of <code class="docutils literal notranslate"><span class="pre">count</span></code> , <code class="docutils literal notranslate"><span class="pre">rate</span></code> , or <code class="docutils literal notranslate"><span class="pre">gauge</span></code>.</p>
45987
-
</dd>
45988
-
</dl>
45971
+
<p>Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.</p>
<li><p><strong>aggregations</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations" title="datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations"><em>MetricCustomAggregations</em></a><em>, </em><em>optional</em>) – <p>A list of queryable aggregation combinations for a count, rate, or gauge metric.
46934
-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
46935
-
Gauge metrics require the (time: avg, space: avg) aggregation.
46936
-
Additional time & space combinations are also available:</p>
46937
-
<ul>
46938
-
<li><p>time: avg, space: avg</p></li>
46939
-
<li><p>time: avg, space: max</p></li>
46940
-
<li><p>time: avg, space: min</p></li>
46941
-
<li><p>time: avg, space: sum</p></li>
46942
-
<li><p>time: count, space: sum</p></li>
46943
-
<li><p>time: max, space: max</p></li>
46944
-
<li><p>time: min, space: min</p></li>
46945
-
<li><p>time: sum, space: avg</p></li>
46946
-
<li><p>time: sum, space: sum</p></li>
46947
-
</ul>
46948
-
<p>Can only be applied to non_distribution metrics that have a <code class="docutils literal notranslate"><span class="pre">metric_type</span></code> of <code class="docutils literal notranslate"><span class="pre">count</span></code> , <code class="docutils literal notranslate"><span class="pre">rate</span></code> , or <code class="docutils literal notranslate"><span class="pre">gauge</span></code>.</p>
46949
-
</p></li>
46916
+
<li><p><strong>aggregations</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations" title="datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations"><em>MetricCustomAggregations</em></a><em>, </em><em>optional</em>) – Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.</p></li>
46950
46917
<li><p><strong>created_at</strong> (<em>datetime</em><em>, </em><em>optional</em>) – Timestamp when the tag configuration was created.</p></li>
46951
46918
<li><p><strong>exclude_tags_mode</strong> (<em>bool</em><em>, </em><em>optional</em>) – When set to true, the configuration will exclude the configured tags and include any other submitted tags.
46952
46919
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
<li><p><strong>aggregations</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations" title="datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations"><em>MetricCustomAggregations</em></a><em>, </em><em>optional</em>) – <p>A list of queryable aggregation combinations for a count, rate, or gauge metric.
46979
-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
46980
-
Gauge metrics require the (time: avg, space: avg) aggregation.
46981
-
Additional time & space combinations are also available:</p>
46982
-
<ul>
46983
-
<li><p>time: avg, space: avg</p></li>
46984
-
<li><p>time: avg, space: max</p></li>
46985
-
<li><p>time: avg, space: min</p></li>
46986
-
<li><p>time: avg, space: sum</p></li>
46987
-
<li><p>time: count, space: sum</p></li>
46988
-
<li><p>time: max, space: max</p></li>
46989
-
<li><p>time: min, space: min</p></li>
46990
-
<li><p>time: sum, space: avg</p></li>
46991
-
<li><p>time: sum, space: sum</p></li>
46992
-
</ul>
46993
-
<p>Can only be applied to non_distribution metrics that have a <code class="docutils literal notranslate"><span class="pre">metric_type</span></code> of <code class="docutils literal notranslate"><span class="pre">count</span></code> , <code class="docutils literal notranslate"><span class="pre">rate</span></code> , or <code class="docutils literal notranslate"><span class="pre">gauge</span></code>.</p>
46994
-
</p></li>
46945
+
<li><p><strong>aggregations</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations" title="datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations"><em>MetricCustomAggregations</em></a><em>, </em><em>optional</em>) – Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.</p></li>
46995
46946
<li><p><strong>exclude_tags_mode</strong> (<em>bool</em><em>, </em><em>optional</em>) – When set to true, the configuration will exclude the configured tags and include any other submitted tags.
46996
46947
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
46997
46948
Defaults to false. Requires <code class="docutils literal notranslate"><span class="pre">tags</span></code> property.</p></li>
<li><p><strong>aggregations</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations" title="datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations"><em>MetricCustomAggregations</em></a><em>, </em><em>optional</em>) – <p>A list of queryable aggregation combinations for a count, rate, or gauge metric.
47173
-
By default, count and rate metrics require the (time: sum, space: sum) aggregation and
47174
-
Gauge metrics require the (time: avg, space: avg) aggregation.
47175
-
Additional time & space combinations are also available:</p>
47176
-
<ul>
47177
-
<li><p>time: avg, space: avg</p></li>
47178
-
<li><p>time: avg, space: max</p></li>
47179
-
<li><p>time: avg, space: min</p></li>
47180
-
<li><p>time: avg, space: sum</p></li>
47181
-
<li><p>time: count, space: sum</p></li>
47182
-
<li><p>time: max, space: max</p></li>
47183
-
<li><p>time: min, space: min</p></li>
47184
-
<li><p>time: sum, space: avg</p></li>
47185
-
<li><p>time: sum, space: sum</p></li>
47186
-
</ul>
47187
-
<p>Can only be applied to non_distribution metrics that have a <code class="docutils literal notranslate"><span class="pre">metric_type</span></code> of <code class="docutils literal notranslate"><span class="pre">count</span></code> , <code class="docutils literal notranslate"><span class="pre">rate</span></code> , or <code class="docutils literal notranslate"><span class="pre">gauge</span></code>.</p>
47188
-
</p></li>
47123
+
<li><p><strong>aggregations</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations" title="datadog_api_client.v2.model.metric_custom_aggregations.MetricCustomAggregations"><em>MetricCustomAggregations</em></a><em>, </em><em>optional</em>) – Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.</p></li>
47189
47124
<li><p><strong>exclude_tags_mode</strong> (<em>bool</em><em>, </em><em>optional</em>) – When set to true, the configuration will exclude the configured tags and include any other submitted tags.
47190
47125
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
47191
47126
Defaults to false. Requires <code class="docutils literal notranslate"><span class="pre">tags</span></code> property.</p></li>
0 commit comments