diff --git a/pages/doc/integrations_custom_app_metrics_howto.md b/pages/doc/integrations_custom_app_metrics_howto.md index 97a58d16a..d2ef8c89e 100644 --- a/pages/doc/integrations_custom_app_metrics_howto.md +++ b/pages/doc/integrations_custom_app_metrics_howto.md @@ -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. diff --git a/pages/doc/metric_types.md b/pages/doc/metric_types.md index 3bfe88919..7148b62d9 100644 --- a/pages/doc/metric_types.md +++ b/pages/doc/metric_types.md @@ -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. @@ -60,6 +58,7 @@ The following table gives an overview of metric types. We introduce each type in + ## Gauges @@ -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. diff --git a/pages/doc/metrics_managing.md b/pages/doc/metrics_managing.md index f8f6758fd..4276eb45a 100644 --- a/pages/doc/metrics_managing.md +++ b/pages/doc/metrics_managing.md @@ -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. @@ -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." %} diff --git a/pages/doc/missing_data_troubleshooting.md b/pages/doc/missing_data_troubleshooting.md index c908f0f72..c20964a7b 100644 --- a/pages/doc/missing_data_troubleshooting.md +++ b/pages/doc/missing_data_troubleshooting.md @@ -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? + + 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. diff --git a/pages/doc/terms_of_service.md b/pages/doc/terms_of_service.md index f73eeb34d..7b6d94916 100644 --- a/pages/doc/terms_of_service.md +++ b/pages/doc/terms_of_service.md @@ -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." %} + + ## Terms of Service Your Terms of Service are different depending on when you became a customer. + If you became a customer on or after August 17, 2017: diff --git a/pages/doc/wavefront_internal_metrics.md b/pages/doc/wavefront_internal_metrics.md index 8230fec3a..a7d1fa423 100644 --- a/pages/doc/wavefront_internal_metrics.md +++ b/pages/doc/wavefront_internal_metrics.md @@ -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. diff --git a/pages/doc/wavefront_pricing.md b/pages/doc/wavefront_pricing.md index f243dd42b..0d1553bd3 100644 --- a/pages/doc/wavefront_pricing.md +++ b/pages/doc/wavefront_pricing.md @@ -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) - + + ## Learn More * [Improve PPS and Prevent Overage](wavefront_usage_info.html) diff --git a/pages/doc/wavefront_release_notes.md b/pages/doc/wavefront_release_notes.md index feaee1e14..d8841a7b2 100644 --- a/pages/doc/wavefront_release_notes.md +++ b/pages/doc/wavefront_release_notes.md @@ -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). diff --git a/pages/doc/wavefront_spring_boot3.md b/pages/doc/wavefront_spring_boot3.md index 37607ddbd..85ba56be3 100644 --- a/pages/doc/wavefront_spring_boot3.md +++ b/pages/doc/wavefront_spring_boot3.md @@ -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. diff --git a/pages/doc/wavefront_spring_boot3_tutorial.md b/pages/doc/wavefront_spring_boot3_tutorial.md index e43bd8529..ec3ca2103 100644 --- a/pages/doc/wavefront_spring_boot3_tutorial.md +++ b/pages/doc/wavefront_spring_boot3_tutorial.md @@ -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}} -

Make sure that the Wavefront for Spring Boot dependency is compatible with the Spring Boot release version. See System Requirements to get the correct dependency version. -
- For example, if you are using Spring Boot release version 3.0.1, the VERSION must be 3.0.1. -

- {{site.data.alerts.end}} - ```xml - - +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}} +

Make sure that the Wavefront for Spring Boot dependency is compatible with the Spring Boot release version. See System Requirements to get the correct dependency version. +
+ For example, if you are using Spring Boot release version 3.0.1, the VERSION must be 3.0.1. +

+ {{site.data.alerts.end}} + ```xml + + + + com.wavefront + wavefront-spring-boot-bom + VERSION + pom + import + + + + ``` + + 1. Add the `wavefront-spring-boot-starter` and `micrometer-registry-wavefront` dependencies. + ```xml com.wavefront - wavefront-spring-boot-bom - VERSION - pom - import + wavefront-spring-boot-starter - - - ``` - -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 ``. - ```xml - - com.wavefront - wavefront-spring-boot-starter - - - io.micrometer - micrometer-registry-wavefront - runtime - - ``` + + io.micrometer + micrometer-registry-wavefront + runtime + + ``` -1. Add the following dependencies to your pom.xml to send trace data to Wavefront. - ```xml - - io.micrometer - micrometer-tracing-bridge-brave - - - io.micrometer - micrometer-tracing-reporter-wavefront - runtime - - ``` + 1. Add the `micrometer-tracing-bridge-brave` and `micrometer-tracing-reporter-wavefront` dependencies to send trace data to our service. + ```xml + + io.micrometer + micrometer-tracing-bridge-brave + + + io.micrometer + micrometer-tracing-reporter-wavefront + runtime + + ``` -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}} -

Check the Datasource Micrometer releases and enter the latest version in place of VERSION.

- {{site.data.alerts.end}} - ```xml - - net.ttddyy.observation - datasource-micrometer-spring-boot - VERSION - runtime - - ``` + 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}} +

Check the Datasource Micrometer releases and enter the latest version in place of VERSION.

+ {{site.data.alerts.end}} + ```xml + + net.ttddyy.observation + datasource-micrometer-spring-boot + VERSION + runtime + + ``` 1. Add the following configurations to the `application.properties` file so that your: * Application is named `spring-demo`. @@ -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: diff --git a/pages/doc/wavefront_spring_boot_faq.md b/pages/doc/wavefront_spring_boot_faq.md index c569836c3..9af681c4a 100644 --- a/pages/doc/wavefront_spring_boot_faq.md +++ b/pages/doc/wavefront_spring_boot_faq.md @@ -36,7 +36,7 @@ Follow these steps: While this is subject to changes at any time, we currently retain 5 days of data and offer no SLA on our free cluster. Freemium accounts that are are inactive for 3 days are automatically deleted. -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 a 99.95% uptime guarantee, as well as High Availability (HA) and Disaster Recovery (DR) options. + ## Why Do I Not See a Link to Access the Free Service on Start-Up?