Add warning logs if config options are not specified; Add sample .env

Author: TanmayArya-1p

.env

@@ -8,3 +8,4 @@ DATABASE_NAME3=Enter-name-3-here
 
 GRPC_SERVER_ROOT_PASSWORD=1234
 GRPC_SERVER_DIMENSION=3
+GRPC_SERVER_STORAGE_TYPE=rocksdb

crates/grpc_server/.env

@@ -0,0 +1,9 @@
+GRPC_SERVER_ROOT_PASSWORD=123 // required
+GRPC_SERVER_DIMENSION=3 // required
+
+GRPC_SERVER_HOST=localhost // defaults to 127.0.0.1 aka localhost
+GRPC_SERVER_PORT=8080 // defaults to 8080
+GRPC_SERVER_STORAGE_TYPE=inmemory // (inmemory/rocksdb) defaults to inmemory
+GRPC_SERVER_INDEX_TYPE=flat // defaults to flat
+GRPC_SERVER_DATA_PATH=data // defaults to a temporary directory
+GRPC_SERVER_LOGGING=true // defaults to true

crates/grpc_server/.sample.env

@@ -11,6 +11,7 @@ use std::path::PathBuf;
 use std::{env, fs};
 use storage;
 use tempfile::tempdir;
+use tracing::{Level, event};
 
 pub struct GRPCServerConfig {
     pub addr: SocketAddr,
@@ -24,10 +25,21 @@ impl GRPCServerConfig {
         dotenv().ok();
 
         // fetch server host; default to localhost if not defined
-        let host = env::var(constants::ENV_HOST).unwrap_or("127.0.0.1".to_string());
+        let host = env::var(constants::ENV_HOST)
+            .inspect_err(|_| {
+                event!(Level::WARN, "Host not defined, defaulting to 'localhost'");
+            })
+            .unwrap_or("127.0.0.1".to_string());
 
         // fetch server port; default to 8080 if not defined
         let port: u32 = env::var(ENV_PORT)
+            .inspect_err(|_| {
+                event!(
+                    Level::WARN,
+                    "Port not defined, defaulting to {}",
+                    DEFAULT_PORT
+                );
+            })
             .unwrap_or(DEFAULT_PORT.to_string())
             .parse()
             .unwrap();
@@ -38,7 +50,14 @@ impl GRPCServerConfig {
         })?;
 
         // fetch server storage type
-        let storage_type_str = env::var(ENV_STORAGE_TYPE).unwrap_or_default();
+        let storage_type_str = env::var(ENV_STORAGE_TYPE)
+            .inspect_err(|_| {
+                event!(
+                    Level::WARN,
+                    "Storage Type not defined, defaulting to InMemory"
+                )
+            })
+            .unwrap_or_default();
         let storage_type = match storage_type_str.as_str() {
             "inmemory" => storage::StorageType::InMemory,
             "rocksdb" => storage::StorageType::RocksDb,
@@ -47,6 +66,7 @@ impl GRPCServerConfig {
 
         // fetch server index type
         let index_type_str = env::var(ENV_INDEX_TYPE)
+            .inspect_err(|_| event!(Level::WARN, "Index Type not defined, defaulting to flat"))
             .unwrap_or("flat".to_string())
             .to_lowercase();
         let index_type = match index_type_str.as_str() {
@@ -69,7 +89,12 @@ impl GRPCServerConfig {
             fs::create_dir_all(&data_path).map_err(|_| errors::ConfigError::InvalidDataPath)?;
         } else {
             let tempbuf = tempdir().unwrap().path().to_path_buf().join("vectordb");
-            fs::create_dir(&tempbuf);
+            fs::create_dir_all(&tempbuf)?;
+            event!(
+                Level::WARN,
+                "Data Path not specified, using temporary directory: {:?}",
+                tempbuf.clone()
+            );
             data_path = tempbuf;
         }
 

crates/grpc_server/src/config.rs

@@ -11,4 +11,4 @@ pub const ENV_LOGGING: &str = "GRPC_SERVER_LOGGING";
 
 pub const DEFAULT_PORT: &str = "8080";
 
-pub const SIMILARITY_PROTOBUF_MAP: [Similarity; 4] = [Euclidean, Manhattan, Hamming, Cosine];
+pub const SIMILARITY_PROTOBUFF_MAP: [Similarity; 4] = [Euclidean, Manhattan, Hamming, Cosine];

crates/grpc_server/src/constants.rs

@@ -1,7 +1,7 @@
 use api;
 use defs;
 use grpc_server::config::GRPCServerConfig;
-use grpc_server::constants::SIMILARITY_PROTOBUF_MAP;
+use grpc_server::constants::SIMILARITY_PROTOBUFF_MAP;
 use grpc_server::interceptors;
 use grpc_server::utils::log_rpc;
 use std::panic;
@@ -93,7 +93,7 @@ impl VectorDb for VectorDBService {
 
         // extract request arguments
         let query_vect = search_request.query_vector.unwrap();
-        let similarity = SIMILARITY_PROTOBUF_MAP[search_request.similarity as usize];
+        let similarity = SIMILARITY_PROTOBUFF_MAP[search_request.similarity as usize];
         let limit = search_request.limit;
 
         let result_point_ids = self