PsiACE commented on code in PR #1931: URL: https://github.com/apache/incubator-opendal/pull/1931#discussion_r1164949457
########## core/src/layers/minitrace.rs: ########## @@ -0,0 +1,405 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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. + +use std::fmt::Debug; +use std::io; +use std::task::Context; +use std::task::Poll; + +use async_trait::async_trait; +use bytes::Bytes; +use futures::FutureExt; +use minitrace::prelude::*; + +use crate::ops::*; +use crate::raw::oio::{PageOperation, ReadOperation, WriteOperation}; +use crate::raw::*; +use crate::*; + +/// Add [minitrace](https://docs.rs/minitrace/) for every operations. +/// +/// # Examples +/// +/// ## Basic Setup +/// +/// ``` +/// use anyhow::Result; +/// use opendal::layers::MinitraceLayer; +/// use opendal::services; +/// use opendal::Operator; +/// +/// let _ = Operator::new(services::Memory::default()) +/// .expect("must init") +/// .layer(MinitraceLayer) +/// .finish(); +/// ``` +/// +/// ## Real usage +/// +/// ```no_run +/// use std::error::Error; +/// +/// use anyhow::Result; +/// use futures::executor::block_on; +/// use opendal::layers::MinitraceLayer; +/// use opendal::services; +/// use opendal::Operator; +/// +/// fn main() -> Result<(), Box<dyn Error + Send + Sync + 'static>> { +/// let collector = { +/// let (span, collector) = minitrace::Span::root("op"); +/// let _g = span.set_local_parent(); +/// let runtime = tokio::runtime::Runtime::new()?; +/// +/// runtime.block_on(async { +/// let _ = dotenvy::dotenv(); +/// let op = Operator::from_env::<services::Memory>() +/// .expect("init operator must succeed") +/// .layer(MinitraceLayer) +/// .finish(); +/// +/// op.write("test", "0".repeat(16 * 1024 * 1024).into_bytes()) +/// .await +/// .expect("must succeed"); +/// op.stat("test").await.expect("must succeed"); +/// op.read("test").await.expect("must succeed"); +/// }); +/// collector +/// }; +/// +/// let spans = block_on(collector.collect()); +/// +/// let bytes = +/// minitrace_jaeger::encode("opendal".to_owned(), rand::random(), 0, 0, &spans).unwrap(); +/// minitrace_jaeger::report_blocking("127.0.0.1:6831".parse().unwrap(), &bytes) +/// .expect("report error"); +/// +/// Ok(()) +/// } +/// ``` +/// +/// # Output +/// +/// OpenDAL is using [`minitrace`](https://docs.rs/minitrace/latest/minitrace/) for tracing internally. +/// +/// To enable minitrace output, please init one of the reporter that `minitrace` supports. +/// +/// For example: +/// +/// ```ignore +/// extern crate minitrace_jaeger; +/// +/// let spans = block_on(collector.collect()); +/// +/// let bytes = +/// minitrace_jaeger::encode("opendal".to_owned(), rand::random(), 0, 0, &spans).unwrap(); +/// minitrace_jaeger::report_blocking("127.0.0.1:6831".parse().unwrap(), &bytes).expect("report error"); +/// ``` +/// +/// For real-world usage, please take a look at [`minitrace-datadog`](https://crates.io/crates/minitrace-datadog) or [`minitrace-jaeger`](https://crates.io/crates/minitrace-jaeger) . +pub struct MinitraceLayer; + +impl<A: Accessor> Layer<A> for MinitraceLayer { + type LayeredAccessor = MinitraceAccessor<A>; + + fn layer(&self, inner: A) -> Self::LayeredAccessor { + MinitraceAccessor { inner } + } +} + +#[derive(Debug)] +pub struct MinitraceAccessor<A> { + inner: A, +} + +#[async_trait] +impl<A: Accessor> LayeredAccessor for MinitraceAccessor<A> { + type Inner = A; + type Reader = MinitraceWrapper<A::Reader>; + type BlockingReader = MinitraceWrapper<A::BlockingReader>; + type Writer = MinitraceWrapper<A::Writer>; + type BlockingWriter = MinitraceWrapper<A::BlockingWriter>; + type Pager = MinitraceWrapper<A::Pager>; + type BlockingPager = MinitraceWrapper<A::BlockingPager>; + + fn inner(&self) -> &Self::Inner { + &self.inner + } + + #[trace("metadata")] + fn metadata(&self) -> AccessorInfo { + self.inner.info() + } + + #[trace("create", enter_on_poll = true)] + async fn create(&self, path: &str, args: OpCreate) -> Result<RpCreate> { + self.inner.create(path, args).await + } + + async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> { + self.inner + .read(path, args) + .map(|v| { + v.map(|(rp, r)| { + ( + rp, + MinitraceWrapper::new(Span::enter_with_local_parent("ReadOperation"), r), + ) + }) + }) + .enter_on_poll("read") + .await + } + + async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> { + self.inner + .write(path, args) + .map(|v| { + v.map(|(rp, r)| { + ( + rp, + MinitraceWrapper::new(Span::enter_with_local_parent("WriteOperation"), r), + ) + }) + }) + .enter_on_poll("write") + .await + } + + #[trace("stat", enter_on_poll = true)] + async fn stat(&self, path: &str, args: OpStat) -> Result<RpStat> { + self.inner.stat(path, args).await + } + + #[trace("delete", enter_on_poll = true)] + async fn delete(&self, path: &str, args: OpDelete) -> Result<RpDelete> { + self.inner.delete(path, args).await + } + + async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Pager)> { + self.inner + .list(path, args) + .map(|v| { + v.map(|(rp, s)| { + ( + rp, + MinitraceWrapper::new(Span::enter_with_local_parent("PageOperation"), s), + ) + }) + }) + .enter_on_poll("list") + .await + } + + async fn scan(&self, path: &str, args: OpScan) -> Result<(RpScan, Self::Pager)> { + self.inner + .scan(path, args) + .map(|v| { + v.map(|(rp, s)| { + ( + rp, + MinitraceWrapper::new(Span::enter_with_local_parent("PageOperation"), s), Review Comment: ok, remove enter_on_poll -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
