1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// 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.
//
// This product includes software developed at Datadog (https://www.datadoghq.com/) Copyright 2025 Datadog, Inc.
//! # Instrumented Object Store
//!
//! Adds tracing instrumentation to any [Object Store](https://docs.rs/object_store/) implementation.
//!
//! # Features
//!
//! - Automatically captures spans for all storage operations (get, put, list, etc.)
//! - Records metadata like file paths and content sizes
//! - Captures error details when operations fail
//! - Works with OpenTelemetry for distributed tracing
//!
//! # Getting Started
//!
//! ```rust
//! # use object_store::{path::Path, ObjectStore, ObjectStoreExt};
//! # use std::sync::Arc;
//! # use instrumented_object_store::instrument_object_store;
//! # use datafusion::execution::context::SessionContext;
//! # use url::Url;
//! # use object_store::Result;
//!
//! # async fn example() -> Result<()> {
//! // Create your object store
//! let store = Arc::new(object_store::local::LocalFileSystem::new());
//!
//! // Wrap it with instrumentation (prefix for span names)
//! let instrumented_store = instrument_object_store(store, "local_fs");
//!
//! // Use directly for file operations
//! let result = instrumented_store.get(&Path::from("path/to/file")).await?;
//!
//! // Or integrate with DataFusion
//! let ctx = SessionContext::new();
//! ctx.register_object_store(&Url::parse("file://").unwrap(), instrumented_store);
//! # Ok(())
//! # }
//! ```
//!
//! When combined with the [`datafusion-tracing`](https://github.com/datafusion-contrib/datafusion-tracing/tree/main/datafusion-tracing)
//! crate, this provides end-to-end visibility from query execution to storage operations.
pub use instrument_object_store;