indexer:add experimental warning (#18890)

MystenLabs · Aug 21, 2024 · 61dc132 · 61dc132
1 parent c6eb1e7
commit 61dc132
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/crates/sui-indexer/README.md b/crates/sui-indexer/README.md
@@ -1,5 +1,7 @@
 Sui indexer is an off-fullnode service to serve data from Sui protocol, including both data directly generated from chain and derivative data.
 
+&#9888; **Warning:** Sui indexer is still experimental and we expect occasional breaking changes that require backfills.
+
 ## Architecture
 ![enhanced_FN](https://user-images.githubusercontent.com/106119108/221022505-a1d873c6-60e2-45f1-b2aa-e50192c4dfbb.png)
 

diff --git a/crates/sui-indexer/src/main.rs b/crates/sui-indexer/src/main.rs
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use clap::Parser;
-use tracing::info;
+use tracing::{info, warn};
 
 use sui_indexer::errors::IndexerError;
 use sui_indexer::metrics::start_prometheus_server;
@@ -14,6 +14,7 @@ async fn main() -> Result<(), IndexerError> {
     let _guard = telemetry_subscribers::TelemetryConfig::new()
         .with_env()
         .init();
+    warn!("WARNING: Sui indexer is still experimental and we expect occasional breaking changes that require backfills.");
 
     let mut indexer_config = IndexerConfig::parse();
     // TODO: remove. Temporary safeguard to migrate to `rpc_client_url` usage