-
Notifications
You must be signed in to change notification settings - Fork 317
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
613452a
commit 9dfca4d
Showing
6 changed files
with
257 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| // Copyright 2023 Greptime Team | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //! object storage utilities | ||
|
|
||
| mod azblob; | ||
| mod fs; | ||
| mod gcs; | ||
| mod oss; | ||
| mod s3; | ||
|
|
||
| use std::sync::Arc; | ||
| use std::time::Duration; | ||
| use std::{env, path}; | ||
|
|
||
| use common_base::readable_size::ReadableSize; | ||
| use common_telemetry::{info, warn}; | ||
| use object_store::layers::{LruCacheLayer, RetryInterceptor, RetryLayer}; | ||
| use object_store::services::Fs; | ||
| use object_store::util::{join_dir, normalize_dir, with_instrument_layers}; | ||
| use object_store::{Access, Error, HttpClient, ObjectStore, ObjectStoreBuilder}; | ||
| use snafu::prelude::*; | ||
|
|
||
| use crate::config::{ObjectStoreConfig, DEFAULT_OBJECT_STORE_CACHE_SIZE}; | ||
| use crate::error::{self, Result}; | ||
|
|
||
| pub(crate) async fn new_raw_object_store( | ||
| store: &ObjectStoreConfig, | ||
| data_home: &str, | ||
| ) -> Result<ObjectStore> { | ||
| let data_home = normalize_dir(data_home); | ||
| let object_store = match store { | ||
| ObjectStoreConfig::File(file_config) => { | ||
| fs::new_fs_object_store(&data_home, file_config).await | ||
| } | ||
| ObjectStoreConfig::S3(s3_config) => s3::new_s3_object_store(s3_config).await, | ||
| ObjectStoreConfig::Oss(oss_config) => oss::new_oss_object_store(oss_config).await, | ||
| ObjectStoreConfig::Azblob(azblob_config) => { | ||
| azblob::new_azblob_object_store(azblob_config).await | ||
| } | ||
| ObjectStoreConfig::Gcs(gcs_config) => gcs::new_gcs_object_store(gcs_config).await, | ||
| }?; | ||
| Ok(object_store) | ||
| } | ||
|
|
||
| fn with_retry_layers(object_store: ObjectStore) -> ObjectStore { | ||
| object_store.layer( | ||
| RetryLayer::new() | ||
| .with_jitter() | ||
| .with_notify(PrintDetailedError), | ||
| ) | ||
| } | ||
|
|
||
| pub(crate) async fn new_object_store_without_cache( | ||
| store: &ObjectStoreConfig, | ||
| data_home: &str, | ||
| ) -> Result<ObjectStore> { | ||
| let object_store = new_raw_object_store(store, data_home).await?; | ||
| // Enable retry layer and cache layer for non-fs object storages | ||
| let object_store = with_retry_layers(object_store); | ||
|
|
||
| let object_store = with_instrument_layers(object_store, true); | ||
| Ok(object_store) | ||
| } | ||
|
|
||
| pub(crate) async fn new_object_store( | ||
| store: ObjectStoreConfig, | ||
| data_home: &str, | ||
| ) -> Result<ObjectStore> { | ||
| let object_store = new_raw_object_store(&store, data_home).await?; | ||
| // Enable retry layer and cache layer for non-fs object storages | ||
| let object_store = { | ||
| let object_store = if let Some(cache_layer) = build_cache_layer(&store).await? { | ||
| // Adds cache layer | ||
| object_store.layer(cache_layer) | ||
| } else { | ||
| object_store | ||
| }; | ||
|
|
||
| // Adds retry layer | ||
| with_retry_layers(object_store) | ||
| }; | ||
|
|
||
| let object_store = with_instrument_layers(object_store, true); | ||
| Ok(object_store) | ||
| } | ||
|
|
||
| async fn build_cache_layer( | ||
| store_config: &ObjectStoreConfig, | ||
| ) -> Result<Option<LruCacheLayer<impl Access>>> { | ||
| let path = "/tmp/local_cache".to_string(); | ||
| let (cache_path, cache_capacity) = match store_config { | ||
| ObjectStoreConfig::S3(s3_config) => { | ||
| let path = s3_config.cache.cache_path.as_ref(); | ||
| let capacity = s3_config | ||
| .cache | ||
| .cache_capacity | ||
| .unwrap_or(DEFAULT_OBJECT_STORE_CACHE_SIZE); | ||
| (path, capacity) | ||
| } | ||
| ObjectStoreConfig::Oss(oss_config) => { | ||
| let path = oss_config.cache.cache_path.as_ref(); | ||
| let capacity = oss_config | ||
| .cache | ||
| .cache_capacity | ||
| .unwrap_or(DEFAULT_OBJECT_STORE_CACHE_SIZE); | ||
| (path, capacity) | ||
| } | ||
| ObjectStoreConfig::Azblob(azblob_config) => { | ||
| let path = azblob_config.cache.cache_path.as_ref(); | ||
| let capacity = azblob_config | ||
| .cache | ||
| .cache_capacity | ||
| .unwrap_or(DEFAULT_OBJECT_STORE_CACHE_SIZE); | ||
| (path, capacity) | ||
| } | ||
| ObjectStoreConfig::Gcs(gcs_config) => { | ||
| let path = gcs_config.cache.cache_path.as_ref(); | ||
| let capacity = gcs_config | ||
| .cache | ||
| .cache_capacity | ||
| .unwrap_or(DEFAULT_OBJECT_STORE_CACHE_SIZE); | ||
| (path, capacity) | ||
| } | ||
| _ => (Some(path.), ReadableSize(1024*1024*256)), | ||
| }; | ||
|
|
||
| if let Some(path) = cache_path { | ||
| let atomic_temp_dir = join_dir(path, ".tmp/"); | ||
| clean_temp_dir(&atomic_temp_dir)?; | ||
|
|
||
| let cache_store = Fs::default() | ||
| .root(path) | ||
| .atomic_write_dir(&atomic_temp_dir) | ||
| .build() | ||
| .context(error::InitBackendSnafu)?; | ||
|
|
||
| let cache_layer = LruCacheLayer::new(Arc::new(cache_store), cache_capacity.0 as usize) | ||
| .await | ||
| .context(error::InitBackendSnafu)?; | ||
|
|
||
| info!( | ||
| "Enabled local object storage cache, path: {}, capacity: {}.", | ||
| path, cache_capacity | ||
| ); | ||
|
|
||
| Ok(Some(cache_layer)) | ||
| } else { | ||
| Ok(None) | ||
| } | ||
| } | ||
|
|
||
| pub(crate) fn clean_temp_dir(dir: &str) -> Result<()> { | ||
| if path::Path::new(&dir).exists() { | ||
| info!("Begin to clean temp storage directory: {}", dir); | ||
| std::fs::remove_dir_all(dir).context(error::RemoveDirSnafu { dir })?; | ||
| info!("Cleaned temp storage directory: {}", dir); | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| pub(crate) fn build_http_client() -> Result<HttpClient> { | ||
| let http_builder = { | ||
| let mut builder = reqwest::ClientBuilder::new(); | ||
|
|
||
| // Pool max idle per host controls connection pool size. | ||
| // Default to no limit, set to `0` for disable it. | ||
| let pool_max_idle_per_host = env::var("_GREPTIMEDB_HTTP_POOL_MAX_IDLE_PER_HOST") | ||
| .ok() | ||
| .and_then(|v| v.parse::<usize>().ok()) | ||
| .unwrap_or(usize::MAX); | ||
| builder = builder.pool_max_idle_per_host(pool_max_idle_per_host); | ||
|
|
||
| // Connect timeout default to 30s. | ||
| let connect_timeout = env::var("_GREPTIMEDB_HTTP_CONNECT_TIMEOUT") | ||
| .ok() | ||
| .and_then(|v| v.parse::<u64>().ok()) | ||
| .unwrap_or(30); | ||
| builder = builder.connect_timeout(Duration::from_secs(connect_timeout)); | ||
|
|
||
| // Pool connection idle timeout default to 90s. | ||
| let idle_timeout = env::var("_GREPTIMEDB_HTTP_POOL_IDLE_TIMEOUT") | ||
| .ok() | ||
| .and_then(|v| v.parse::<u64>().ok()) | ||
| .unwrap_or(90); | ||
|
|
||
| builder = builder.pool_idle_timeout(Duration::from_secs(idle_timeout)); | ||
|
|
||
| builder | ||
| }; | ||
|
|
||
| HttpClient::build(http_builder).context(error::InitBackendSnafu) | ||
| } | ||
| struct PrintDetailedError; | ||
|
|
||
| // PrintDetailedError is a retry interceptor that prints error in Debug format in retrying. | ||
| impl RetryInterceptor for PrintDetailedError { | ||
| fn intercept(&self, err: &Error, dur: Duration) { | ||
| warn!("Retry after {}s, error: {:#?}", dur.as_secs_f64(), err); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters