This is an automated email from the ASF dual-hosted git repository.
zhouxzhan pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/rocketmq.git
The following commit(s) were added to refs/heads/develop by this push:
new 5bc38adfe fix readme of tiered storage
5bc38adfe is described below
commit 5bc38adfe0aecf67104bfb805caf1a60fe0802f0
Author: SSpirits <[email protected]>
AuthorDate: Thu Feb 9 17:32:35 2023 +0800
fix readme of tiered storage
---
tieredstore/README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/tieredstore/README.md b/tieredstore/README.md
index d58b5e0c6..9c8ea6b8a 100644
--- a/tieredstore/README.md
+++ b/tieredstore/README.md
@@ -57,8 +57,8 @@ Tiered storage provides some useful metrics, see
[RIP-46](https://github.com/apa
## How to contribute
-We need community participation to add more backend service providers for
tiered storage.
[PosixFileSegment](https://github.com/apache/rocketmq/blob/tiered_storage/tieredstore/src/main/java/org/apache/rocketmq/tieredstore/provider/posix/PosixFileSegment.java),
the implementation provided by default is just an example. People who want to
contribute can follow it to implement their own providers, such as
S3FileSegment, OSSFileSegment, and MinIOFileSegment. Here are some guidelines:
+We need community participation to add more backend service providers for
tiered storage.
[PosixFileSegment](https://github.com/apache/rocketmq/blob/develop/tieredstore/src/main/java/org/apache/rocketmq/tieredstore/provider/posix/PosixFileSegment.java),
the implementation provided by default is just an example. People who want to
contribute can follow it to implement their own providers, such as
S3FileSegment, OSSFileSegment, and MinIOFileSegment. Here are some guidelines:
-1. Extend
[TieredFileSegment](https://github.com/apache/rocketmq/blob/tiered_storage/tieredstore/src/main/java/org/apache/rocketmq/tieredstore/provider/TieredFileSegment.java)
and implement the methods of
[TieredStoreProvider](https://github.com/apache/rocketmq/blob/tiered_storage/tieredstore/src/main/java/org/apache/rocketmq/tieredstore/provider/TieredStoreProvider.java)
interface.
+1. Extend
[TieredFileSegment](https://github.com/apache/rocketmq/blob/develop/tieredstore/src/main/java/org/apache/rocketmq/tieredstore/provider/TieredFileSegment.java)
and implement the methods of
[TieredStoreProvider](https://github.com/apache/rocketmq/blob/develop/tieredstore/src/main/java/org/apache/rocketmq/tieredstore/provider/TieredStoreProvider.java)
interface.
2. Record metrics where appropriate. See
`rocketmq_tiered_store_provider_rpc_latency`,
`rocketmq_tiered_store_provider_upload_bytes`, and
`rocketmq_tiered_store_provider_download_bytes`
3. No need to maintain your own cache and avoid polluting the page cache. It
is already having the read-ahead cache.
