Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pushing master updates #1035

Merged
merged 20 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a709523
minor change to start the build
shavidissa Feb 12, 2024
58588c5
Merge branch 'master' of https://github.com/wavefrontHQ/docs into sha…
shavidissa Feb 28, 2024
5a414eb
Internal metrics are ephemeral
mmihaylovam Mar 19, 2024
a2cf741
Merge pull request #1023 from wavefrontHQ/mari-220
mmihaylovam Mar 19, 2024
30ff051
Merge branch 'master' of https://github.com/wavefrontHQ/docs into sha…
shavidissa Mar 22, 2024
98e4423
update the doc
shavidissa Mar 22, 2024
db5847b
Merge pull request #1028 from wavefrontHQ/shavi-bug-fix
shavidissa Mar 25, 2024
67cb2dd
adding a link to the new workbook TAS OTel for Spring Boot Application
mmihaylovam Mar 27, 2024
30a9754
adding a link to the new workbook TAS OTel for Spring Boot Application
mmihaylovam Mar 27, 2024
2abefa1
peer review
mmihaylovam Mar 28, 2024
6751add
peer review
mmihaylovam Mar 28, 2024
5e82f14
Merge pull request #1031 from wavefrontHQ/docs-220
mmihaylovam Mar 29, 2024
51d9126
moving the links to the workbook
mmihaylovam Apr 1, 2024
0871e98
Not all internal metrics are ephemeral
mmihaylovam Apr 3, 2024
7886dbf
unordered list of the persistent internal metrics
mmihaylovam Apr 4, 2024
70321bc
Merge pull request #1032 from wavefrontHQ/mariela-bug-fixes
mmihaylovam Apr 4, 2024
2bdd704
Merge pull request #1030 from wavefrontHQ/mariela-tas
mmihaylovam Apr 4, 2024
1eb7633
Comment out the data retention section from the docs
shavidissa Apr 4, 2024
9afd0b2
Merge pull request #1033 from wavefrontHQ/shavi-bug-fix
mmihaylovam Apr 5, 2024
b2ee61b
Merge branch 'master' of https://github.com/wavefrontHQ/docs into mar…
mmihaylovam Apr 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/doc/integrations_custom_app_metrics_howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The supported way to do this using the Tanzu Observability by Wavefront Nozzle i

### Spring Boot

Spring Boot is commonly used to build apps running on TAS.
Spring Boot is commonly used to build apps running on TAS. To use a VMware Tanzu solutions workbook, see [Instrumenting TAS OpenTelemetry for Spring Boot Application](https://docs.vmware.com/en/VMware-Tanzu-Reference-Architecture/services/tanzu-solutions-workbooks/solution-workbooks-TAS-OpenTelemetry-SpringBoot-TO.html).

Spring Boot Actuator supports both push and pull models, with the only difference typically being configuration changes. In that case, it becomes relatively easy to switch from push to pull or vice-versa.

Expand Down
10 changes: 5 additions & 5 deletions pages/doc/metric_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ summary: Learn about gauges, counters, delta counters, histograms, and spans.

{% include tip.html content="Wavefront co-founder Clement Pang wrote [a Medium article](https://medium.com/@clementpang/thoughts-from-the-front-line-why-wavefront-3d807e2106f) that explains different metric types and why they are so powerful." %}

## Summary of Metric Types

### Metric Types per Data Type
## Metric Types per Data Type

The following table gives an overview of metric types. We introduce each type in more detail below.

Expand Down Expand Up @@ -60,6 +58,7 @@ The following table gives an overview of metric types. We introduce each type in
</tbody>
</table>

<!--
### Metric Types per Retention Period
With the 2024-05 release, we introduce **ephemeral** metrics, which have a short [retention period](terms_of_service.html#data-retention).
Expand All @@ -71,16 +70,18 @@ With the 2024-05 release, we introduce **ephemeral** metrics, which have a short
</thead>
<tr>
<td>Persistent</td>
<td>18 months of data retention. By default, all metrics and counters are persistent. Metrics are convertible to ephemeral.</td>
<td>18 months of data retention. By default, all ingested metrics are persistent but are convertible to ephemeral. Counters are persistent and not convertible.</td>
</tr>
<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, 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>
</tbody>
</table>
-->

## Gauges

Expand Down Expand Up @@ -109,7 +110,6 @@ To have the Tanzu Observability service treat a metric as a delta counter, you h

[Using Delta Counters](delta_counters.html#using-delta-counters) gives details and best practices.


## Histograms

Tanzu Observability can receive and store metrics at 1 point per second per unique source. However, some scenarios generate metrics even more frequently. Suppose you are measuring the latency of web requests. If you have a lot of traffic at multiple servers, you may have multiple distinct measurements for a given metric, timestamp, and source. Using "normal” metrics, we can’t measure this.
Expand Down
6 changes: 3 additions & 3 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.
* 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 @@ -160,11 +160,11 @@ The selected metrics and metric prefixes appear again as long as they are not ob

### Change the Retention Period of Metrics

With the 2024-05 release, we introduce **ephemeral** metrics, which have short [retention period](terms_of_service.html#data-retention). By default, all ingested metrics are persistent but are convertible to ephemeral.
With the 2024-05 release, we introduce **ephemeral** metrics, which have short retention period. By default, all ingested metrics are persistent but are convertible to ephemeral.

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)." %}
{% 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
8 changes: 7 additions & 1 deletion pages/doc/missing_data_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ permalink: missing_data_troubleshooting.html
summary: Learn how to troubleshoot when you expect to see data but it doesn't appear in charts.
---

Sometimes you expect to see certain data in VMware Tanzu Observability (formerly known as VMware Aria Operations for Applications) but, for some reason, it doesn't show up! This can be a frustrating and confusing experience, especially when you urgently need the data. Tanzu Observability does not delete data - the [retention period](terms_of_service.html#data-retention) is 18 months for persistent metrics and 28 days for ephemeral metrics. What could be the problem?
Sometimes you expect to see certain data in VMware Tanzu Observability (formerly known as VMware Aria Operations for Applications) but, for some reason, it doesn't show up! This can be a frustrating and confusing experience, especially when you urgently need the data. What could be the problem?

<!-- Before removing data retention link

Sometimes you expect to see certain data in VMware Aria Operations for Applications (formerly known as Tanzu Observability by Wavefront) but, for some reason, it doesn't show up! This can be a frustrating and confusing experience, especially when you urgently need the data. Operations for Applications does not delete data - the [retention period](terms_of_service.html#data-retention) is 18 months for persistent metrics and 28 days for ephemeral metrics. What could be the problem?

-->

This doc page, based on the extensive experience of our customer success team, helps you investigate, understand, and remedy possible causes. In addition to manually investigating and troubleshooting your issues, you can use the [Query Analyzer](query_language_performance.html#use-the-query-analyzer) which helps you identify where exactly the problem is.

Expand Down
11 changes: 8 additions & 3 deletions pages/doc/terms_of_service.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: Data Retention and Terms of Service
title: Terms of Service
keywords: tos
tags: [tos]
sidebar: doc_sidebar
permalink: terms_of_service.html
summary: Data Retention and Terms of Service
summary: Terms of Service
---
The terms of service and data retention for Tanzu Observability (formerly known as VMware Aria Operations for Applications) differ depending on the contract your company has with VMware. This page gives a summary and links to some relevant information.
The terms of service for VMware Tanzu Observability (formerly known as VMware Aria Operations for Applications) differ depending on the contract your company has with VMware. This page gives a summary and links to some relevant information.

{% include tip.html content="Details vary depending on when you became a customer and on your Service Agreement with VMware." %}

<!--
## Data Retention

A production instance retains different types of data for different amounts of time. While this is subject to change, here are the default settings:
Expand All @@ -33,11 +34,15 @@ See <a href="metric_types.html#metric-types-per-retention-period">Metric Types p
</tbody>
</table>

-->

## Terms of Service

Your Terms of Service are different depending on when you became a customer.

<!--
Production clusters currently offer 18 months of full-resolution (no downsampling) data retention for persistent metrics, 28 days for ephemeral metrics, 6 months for histograms, and 7 days for spans. We also have an uptime guarantee, as well as High Availability (HA) and Disaster Recovery (DR) options.
-->

If you became a customer on or after August 17, 2017:

Expand Down
17 changes: 17 additions & 0 deletions pages/doc/wavefront_internal_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,23 @@ You can:
* Clone and modify one of the Tanzu Observability Usage integration dashboards.
* Create your own dashboard, query these metrics in charts, and create alerts for some of these metrics.

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

We collect the following sets of metrics.
Expand Down
4 changes: 3 additions & 1 deletion pages/doc/wavefront_pricing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For spans, the pricing structure is as follows:

![Metrics 1pps and Histograms 7pps are the basis, distributed tracing is 22 PPS if intelligent sampling is turned off](images/pricing_model_1.png)


<!--
## Data Retention
Default data retention is:
Expand All @@ -37,6 +37,8 @@ Default data retention is:
Some companies negotiate a longer data retention at a higher price. Ask your administrator for details.
-->

## Learn More

* [Improve PPS and Prevent Overage](wavefront_usage_info.html)
Expand Down
22 changes: 22 additions & 0 deletions pages/doc/wavefront_release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,28 @@ In October, 2023, we start to incrementally [**onboard**](csp_migration.html) al

{% include warning.html content="The Tanzu Observability authentication and authorization will be **deprecated** in the future. Therefore, after onboarding to VMware Cloud services, **replace** [your service accounts with server to server apps](csp_migration.html#how-to-replace-a-service-account-with-a-server-to-server-app) and [your Tanzu Observability API tokens with VMware Cloud Services access tokens](csp_migration.html#how-to-replace-an-operations-for-applications-api-token-with-a-vmware-cloud-services-access-token), including [the Operations for Application API tokens of your Wavefront proxies](csp_migration.html#how-to-replace-the-operations-for-application-api-token-of-a-wavefront-proxy)." %}

## 2024-07.x Release Notes

**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

* **New Ephemeral Metric Type**: With this release, we introduce ephemeral metrics, which have a short retention period. Ephemeral metrics are retained for 28 days, whereas persistent (default) metrics are retained for 18 months. For details, see [Metric Types per Retention Period](metric_types.html#metric-types-per-retention-period).
Expand Down
2 changes: 2 additions & 0 deletions pages/doc/wavefront_spring_boot3.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ You can send data from your Spring Boot applications into our service using the
- **Customer or Free Trial User**: Customers or free trial users can modify the default Wavefront Spring Boot Starter to send data to their cluster. You can sign up for a [free 30-day trial here](https://tanzu.vmware.com/observability).
* **Wavefront Spring Boot Integration**: Customers and free trial users can access the Wavefront Spring Boot integration directly from their clusters.

If your Spring Boot applications are running on Tanzu Application Service (TAS), see the VMware Tanzu solutions workbook on [Instrumenting TAS OpenTelemetry for Spring Boot Application](https://docs.vmware.com/en/VMware-Tanzu-Reference-Architecture/services/tanzu-solutions-workbooks/solution-workbooks-TAS-OpenTelemetry-SpringBoot-TO.html).

## Dashboards

After you complete the setup, you can examine the data in our dashboards.
Expand Down
118 changes: 60 additions & 58 deletions pages/doc/wavefront_spring_boot3_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,65 +30,67 @@ In this tutorial, you use Wavefront for Spring Boot that uses Spring Boot 3 with

## Configure the Petclinic Application

1. Import the Wavefront for Spring Boot Bill of Materials (BOM) to your project. Add the following code to the `pom.xml` file (replace VERSION with the current version).
{{site.data.alerts.tip}}
<p> Make sure that the Wavefront for Spring Boot dependency is compatible with the Spring Boot release version. See <a href="wavefront_springboot3.html#versionCompatibility">System Requirements</a> to get the correct dependency version.
<br/>
For example, if you are using Spring Boot release version 3.0.1, the <code>VERSION</code> must be 3.0.1.
</p>
{{site.data.alerts.end}}
```xml
<dependencyManagement>
<dependencies>
1. Add the following configurations to the `pom.xml` file in the sample petclinic application:

1. Import the Wavefront for Spring Boot Bill of Materials (BOM) to your project. Replace VERSION with the current version.
{{site.data.alerts.tip}}
<p> Make sure that the Wavefront for Spring Boot dependency is compatible with the Spring Boot release version. See <a href="wavefront_springboot3.html#versionCompatibility">System Requirements</a> to get the correct dependency version.
<br/>
For example, if you are using Spring Boot release version 3.0.1, the <code>VERSION</code> must be 3.0.1.
</p>
{{site.data.alerts.end}}
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.wavefront</groupId>
<artifactId>wavefront-spring-boot-bom</artifactId>
<version>VERSION</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
```

1. Add the `wavefront-spring-boot-starter` and `micrometer-registry-wavefront` dependencies.
```xml
<dependency>
<groupId>com.wavefront</groupId>
<artifactId>wavefront-spring-boot-bom</artifactId>
<version>VERSION</version>
<type>pom</type>
<scope>import</scope>
<artifactId>wavefront-spring-boot-starter</artifactId>
</dependency>
</dependencies>
</dependencyManagement>
```

1. Open the sample petclinic application using an IDE and add the `wavefront-spring-boot-starter` and `micrometer-registry-wavefront` to the `pom.xml` file's `<dependencies>`.
```xml
<dependency>
<groupId>com.wavefront</groupId>
<artifactId>wavefront-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-wavefront</artifactId>
<scope>runtime</scope>
</dependency>
```
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-registry-wavefront</artifactId>
<scope>runtime</scope>
</dependency>
```

1. Add the following dependencies to your <code>pom.xml</code> to send trace data to Wavefront.
```xml
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing-bridge-brave</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing-reporter-wavefront</artifactId>
<scope>runtime</scope>
</dependency>
```
1. Add the `micrometer-tracing-bridge-brave` and `micrometer-tracing-reporter-wavefront` dependencies to send trace data to our service.
```xml
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing-bridge-brave</artifactId>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-tracing-reporter-wavefront</artifactId>
<scope>runtime</scope>
</dependency>
```

1. Add the `Datasource Micrometer` dependency to intercept and log JDBC SQL queries. You can intercept most Connection, Statement, and ResultSet methods invocations using the Datasource Micrometer dependency.
{{site.data.alerts.tip}}
<p>Check the <a href="https://github.com/jdbc-observations/datasource-micrometer/releases">Datasource Micrometer releases</a> and enter the latest version in place of <code>VERSION</code>.</p>
{{site.data.alerts.end}}
```xml
<dependency>
<groupId>net.ttddyy.observation</groupId>
<artifactId>datasource-micrometer-spring-boot</artifactId>
<version>VERSION</version>
<scope>runtime</scope>
</dependency>
```
1. Add the `datasource-micrometer-spring-boot` dependency to intercept and log JDBC SQL queries. You can intercept most Connection, Statement, and ResultSet methods invocations using the Datasource Micrometer dependency.
{{site.data.alerts.tip}}
<p>Check the <a href="https://github.com/jdbc-observations/datasource-micrometer/releases">Datasource Micrometer releases</a> and enter the latest version in place of <code>VERSION</code>.</p>
{{site.data.alerts.end}}
```xml
<dependency>
<groupId>net.ttddyy.observation</groupId>
<artifactId>datasource-micrometer-spring-boot</artifactId>
<version>VERSION</version>
<scope>runtime</scope>
</dependency>
```

1. Add the following configurations to the `application.properties` file so that your:
* Application is named `spring-demo`.
Expand All @@ -102,17 +104,17 @@ In this tutorial, you use Wavefront for Spring Boot that uses Spring Boot 3 with

## Send Data to Our Service

1. Restart the application and navigate to [http://localhost:8080](http://localhost:8080/).
1. Restart the application.

1. Generate telemetry data from the petclinic user interface.
1. Navigate to [http://localhost:8080](http://localhost:8080/) and generate telemetry data from the petclinic user interface.
For example:
1. Add an Owner and a Pet via the User Interface.
1. Click **VETERINARIANS** to list vets in the database.
1. Click **ERROR** to trigger errors.

1. Click the one-time use link to access the Wavefront for Spring Boot Service Dashboard and view data.
1. Copy the one-time use link that was printed on your terminal when you restarted your application to access the Wavefront for Spring Boot Service Dashboard and view data.
{% include tip.html content = "Make sure to save the one-time use link so you can access the same dashboard each time you restart your application."%}
Example:
Example output on your terminal:
```
To share this account, make sure the following is added to your configuration:

Expand Down
Loading
Loading