Rename BanyanDB native TTL doc to Progressive TTL (#12829)

apache · Dec 5, 2024 · 17003eb · 17003eb
1 parent 6252cd4
commit 17003eb
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/docs/en/banyandb/ttl.md b/docs/en/banyandb/ttl.md
@@ -1,6 +1,8 @@
-# Native TTL
+# Progressive TTL
 
-BanyanDB employs a Time-To-Live (TTL) mechanism to automatically delete data older than the specified duration. When using BanyanDB as the storage backend, the `recordDataTTL` and `metricsDataTTL` configurations are deprecated. Instead, TTL settings should be configured directly within `storage.banyandb`.
+Progressive TTL provides a capability to manage data retention with different TTL settings and Segment Creation Policies based on the time granularity of metrics.
+
+BanyanDB employs a Time-To-Live (TTL) mechanism to automatically delete data older than the specified duration. When using BanyanDB as the storage backend, **the `recordDataTTL` and `metricsDataTTL` configurations are deprecated**. Instead, TTL settings should be configured directly within `storage.banyandb`.
 
 For detailed information, please refer to the [Storage BanyanDB](../setup/backend/storages/banyandb.md) documentation.
 

diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
@@ -30,6 +30,7 @@
 * Bump up netty to 4.1.115, grpc to 1.68.1, boringssl to 2.0.69.
 * BanyanDB: Support update the Group settings when OAP starting.
 * BanyanDB: Introduce index mode and refactor banyandb group settings.
+* BanyanDB: Introduce the new Progressive TTL feature.
 * BanyanDB: Support update the Schema when OAP starting.
 * BanyanDB: Speed up OAP booting while initializing BanyanDB.
 * BanyanDB: Support `@EnableSort` on the column to enable sorting for `IndexRule` and set the default to false.

diff --git a/docs/en/setup/backend/backend-kafka-monitoring.md b/docs/en/setup/backend/backend-kafka-monitoring.md
@@ -13,7 +13,7 @@ Kafka entity as a `Service` in OAP and on the `Layer: KAFKA`.
 
 ## Setup
 
-1. Setup [prometheus_JMX_Exporter](https://github.com/prometheus/jmx_exporter). This is an example for JMX Exporter configuration [kafka-2_0_0.yml](https://github.com/prometheus/jmx_exporter/blob/main/example_configs/kafka-2_0_0.yml).
+1. Setup [prometheus_JMX_Exporter](https://github.com/prometheus/jmx_exporter). This is an example for JMX Exporter configuration [kafka-2_0_0.yml](https://raw.githubusercontent.com/prometheus/jmx_exporter/91622ad478015364444e5d63475d1673c09e6268/examples/kafka-2_0_0.yml).
 2. Set up [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/#kubernetes). The example
    for OpenTelemetry Collector configuration, refer
    to [here](../../../../test/e2e-v2/cases/kafka/kafka-monitoring/otel-collector-config.yaml).

diff --git a/docs/menu.yml b/docs/menu.yml
@@ -200,7 +200,7 @@ catalog:
             path: "/en/setup/backend/backend-health-check"
       - name: "BanyanDB Exclusive Setup"
         catalog:
-          - name: "Native TTL"
+          - name: "Progressive TTL"
             path: "/en/banyandb/ttl"
       - name: "Tracing"
         catalog: