Skip to content

Commit

Permalink
Not all internal metrics are ephemeral
Browse files Browse the repository at this point in the history
  • Loading branch information
mmihaylovam committed Apr 3, 2024
1 parent 5e82f14 commit 0871e98
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pages/doc/metric_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ With the 2024-05 release, we introduce **ephemeral** metrics, which have a short
<tr>
<td>Ephemeral</td>
<td>28 days of data retention. Suitable for metrics that are relevant for a short time and that have high cardinality, such as the Kubernetes metrics (<code>kubernetes.</code>).
<p>By default, only the <a href="wavefront-internal-metrics.html">internal metrics</a> are ephemeral and they are not convertible to persistent.</p>
<p>By default, most of the <a href="wavefront-internal-metrics.html">internal metrics</a> are ephemeral and they are not convertible to persistent.</p>
<p><a href="metrics_managing.html#change-the-retention-period-of-metric">Converting</a> metrics from persistent to ephemeral improves the <a href="query_language_performance.html">query performance</a> and reduces the <a href="cardinality.html">cardinality</a>.</p>
</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions pages/doc/metrics_managing.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ On the Metrics Browser, you can:
* Filter by name or source.
* Hide and redisplay individual metrics or metrics namespaces to unclutter your page.
* View the metric type in terms of retention period - persistent or ephemeral.
* Convert persistent metrics to ephemeral and the reverse. Internal metrics are ephemeral and not convertible.
* Convert persistent metrics to ephemeral and the reverse. Most of the internal metrics are ephemeral and not convertible.
* Create a chart or dashboard for an individual metric or for the current set of metrics.
* View the sources and point tags for an individual metric.

Expand Down Expand Up @@ -164,7 +164,7 @@ With the 2024-05 release, we introduce **ephemeral** metrics, which have short [

Converting persistent metrics to ephemeral can significantly improve the [query performance](query_language_performance.html) and reduce the [cardinality](cardinality.html).

{% include note.html content="To change the retention period of a metric or metrics namespace, you must be a Super Admin user with [enabled Super Admin mode](users_account_managing.html#enable-or-disable-super-admin-mode). Internal metrics are ephemeral and not convertible to persistent." %}
{% include note.html content="To change the retention period of a metric or metrics namespace, you must be a Super Admin user with [enabled Super Admin mode](users_account_managing.html#enable-or-disable-super-admin-mode). Most of the internal metrics are ephemeral and not convertible to persistent." %}

{% include important.html content="Converting a persistent metric to ephemeral **permanently deletes** the data points of this metric that are older than 28 days." %}

Expand Down
5 changes: 4 additions & 1 deletion pages/doc/wavefront_internal_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ You can:
* Clone and modify one of the Operations for Applications Usage integration dashboards.
* Create your own dashboard, query these metrics in charts, and create alerts for some of these metrics.

{% include note.html content="The internal metrics are [**ephemeral**](metric_types.html#metric-types-per-retention-period) and not convertible to persistent." %}
Most of the internal metrics are [**ephemeral**](metric_types.html#metric-types-per-retention-period) and not convertible to persistent. Exceptions are the following internal metrics, which are persistent:
```
~collector.*points.reported, ~externalservices.*.points, ~derived-metrics.points.reported, ~collector.*histograms.reported, ~derived-histograms.histograms.reported, ~collector.*spans.reported, ~query.metrics_scanned, ~proxy.points.*.received, ~proxy.histograms.*.received, ~proxy.spans.*.received, ~proxy.spanLogs.*.received, ~proxy.build.version, ~metric.global.namespace.*, ~histogram.global.namespace.*, ~counter.global.namespace.*
```

## Internal Metrics Overview

Expand Down
5 changes: 4 additions & 1 deletion pages/doc/wavefront_release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ In October, 2023, we start to incrementally [**onboard**](csp_migration.html) al

## 2024-07.x Release Notes

* **Ephemeral Internal Metrics**: All [internal metrics](wavefront-internal-metrics.html) are now [ephemeral](metric_types.html#metric-types-per-retention-period), so that they are retained for 28 days. Internal metrics are not convertible to persistent.
**Ephemeral Internal Metrics**: Most of the [internal metrics](wavefront-internal-metrics.html) are now [ephemeral](metric_types.html#metric-types-per-retention-period) and not convertible to persistent. Exceptions are the following internal metrics, which remain persistent:
```
~collector.*points.reported, ~externalservices.*.points, ~derived-metrics.points.reported, ~collector.*histograms.reported, ~derived-histograms.histograms.reported, ~collector.*spans.reported, ~query.metrics_scanned, ~proxy.points.*.received, ~proxy.histograms.*.received, ~proxy.spans.*.received, ~proxy.spanLogs.*.received, ~proxy.build.version, ~metric.global.namespace.*, ~histogram.global.namespace.*, ~counter.global.namespace.*
```


## 2024-05.x Release Notes
Expand Down

0 comments on commit 0871e98

Please sign in to comment.