Skip to content

Commit d394aa0

Browse files
Mark aggregations arguments as deprecated since they're no longer needed (#2560)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 89297af
1 parent dc58dd1 commit d394aa0

3 files changed

Lines changed: 10 additions & 75 deletions

File tree

datadog_api_client.v2.api.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6745,10 +6745,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
67456745
<span class="sig-name descname"><span class="pre">create_tag_configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_create_request.MetricTagConfigurationCreateRequest" title="datadog_api_client.v2.model.metric_tag_configuration_create_request.MetricTagConfigurationCreateRequest"><span class="pre">MetricTagConfigurationCreateRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.metric_tag_configuration_response.MetricTagConfigurationResponse" title="datadog_api_client.v2.model.metric_tag_configuration_response.MetricTagConfigurationResponse"><span class="pre">MetricTagConfigurationResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.metrics_api.MetricsApi.create_tag_configuration" title="Link to this definition">¶</a></dt>
67466746
<dd><p>Create a tag configuration.</p>
67476747
<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>
6751+
permission.</p>
67526752
<dl class="field-list simple">
67536753
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
67546754
<dd class="field-odd"><p><strong>metric_name</strong> (<em>str</em>) – The name of the metric.</p>
@@ -6798,7 +6798,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
67986798
<li><p><strong>metric_name</strong> (<em>str</em>) – The name of the metric.</p></li>
67996799
<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>
68006800
<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>
68026802
<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>
68036803
<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>
68046804
</ul>

datadog_api_client.v2.model.html

Lines changed: 4 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -45968,24 +45968,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
4596845968
<dt class="sig sig-object py">
4596945969
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MetricCustomAggregations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
4597045970
<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelSimple" title="datadog_api_client.model_utils.ModelSimple"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSimple</span></code></a></p>
45971-
<dl>
45972-
<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 &amp; 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>
4598945972
<dl class="field-list simple">
4599045973
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
4599145974
<dd class="field-odd"><ul class="simple">
@@ -46930,23 +46913,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
4693046913
<dl class="field-list simple">
4693146914
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
4693246915
<dd class="field-odd"><ul class="simple">
46933-
<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 &amp; 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>
4695046917
<li><p><strong>created_at</strong> (<em>datetime</em><em>, </em><em>optional</em>) – Timestamp when the tag configuration was created.</p></li>
4695146918
<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.
4695246919
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
@@ -46975,23 +46942,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
4697546942
<dl class="field-list simple">
4697646943
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
4697746944
<dd class="field-odd"><ul class="simple">
46978-
<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 &amp; 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>
4699546946
<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.
4699646947
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
4699746948
Defaults to false. Requires <code class="docutils literal notranslate"><span class="pre">tags</span></code> property.</p></li>
@@ -47169,23 +47120,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
4716947120
<dl class="field-list simple">
4717047121
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
4717147122
<dd class="field-odd"><ul class="simple">
47172-
<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 &amp; 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>
4718947124
<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.
4719047125
When set to false, the configuration will include the configured tags and exclude any other submitted tags.
4719147126
Defaults to false. Requires <code class="docutils literal notranslate"><span class="pre">tags</span></code> property.</p></li>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)