tracing-cloudwatch 0.4.1

tracing-subscriber layer that sends your application's tracing events(logs) to AWS CloudWatch Logs
Documentation 
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//!  tracing-cloudwatch is a custom tracing-subscriber layer that sends your application's tracing events(logs) to AWS CloudWatch Logs.
//!
//! We have supported [rusoto](https://github.com/rusoto/rusoto) and the [AWS SDK](https://github.com/awslabs/aws-sdk-rust) as AWS clients.
//!
//! ## Usage
//!
//! ### With Rusoto
//!
//! feature `rusoto` required
//!
//! ```rust,no_run
//! # #[cfg(feature = "rusoto")]
//! # {
//! use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
//!
//! #[tokio::main]
//! async fn main() {
//!     let cw_client = rusoto_logs::CloudWatchLogsClient::new(rusoto_core::Region::ApNortheast1);
//!
//!     let (cw_layer, cw_guard) = tracing_cloudwatch::layer().with_client(
//!         cw_client,
//!         tracing_cloudwatch::ExportConfig::default()
//!             .with_batch_size(5)
//!             .with_interval(std::time::Duration::from_secs(1))
//!             .with_log_group_name("tracing-cloudwatch")
//!             .with_log_stream_name("stream-1"),
//!     );
//!
//!     tracing_subscriber::registry::Registry::default()
//!         .with(cw_layer)
//!         .init();
//!
//!     cw_guard.shutdown().await;
//! }
//! # }
//! ```
//!
//! ### With AWS SDK
//!
//! feature `awssdk` required
//!
//! ```rust,no_run
//! # #[cfg(feature = "awssdk")]
//! # {
//! use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
//!
//! #[tokio::main]
//! async fn main() {
//!     let config = aws_config::load_defaults(aws_config::BehaviorVersion::latest()).await;
//!     let cw_client = aws_sdk_cloudwatchlogs::Client::new(&config);
//!
//!     let (cw_layer, cw_guard) = tracing_cloudwatch::layer().with_client(
//!         cw_client,
//!         tracing_cloudwatch::ExportConfig::default()
//!             .with_batch_size(5)
//!             .with_interval(std::time::Duration::from_secs(1))
//!             .with_log_group_name("tracing-cloudwatch")
//!             .with_log_stream_name("stream-1"),
//!     );
//!
//!     tracing_subscriber::registry::Registry::default()
//!         .with(cw_layer)
//!         .init();
//!
//!     cw_guard.shutdown().await;
//! }
//! # }
//! ```
//!
//! ## Required Permissions
//!
//! Currently, following AWS IAM Permissions required
//!
//! * `logs:PutLogEvents`
//!
//! ## CloudWatch Log Groups and Streams
//!
//! This crate does not create a log group and log stream, so if the specified log group and log stream does not exist, it will raise an error.
//!
//! ## Retry and Timeout
//!
//! We haven't implemented any custom retry logic or timeout settings within the crate. We assume that these configurations are handled through the SDK Client.
//! For instance, in the AWS SDK, you can set up these configurations using [`timeout_config`](https://docs.rs/aws-sdk-cloudwatchlogs/0.28.0/aws_sdk_cloudwatchlogs/config/struct.Builder.html#method.timeout_config) and [`retry_config`](https://docs.rs/aws-sdk-cloudwatchlogs/0.28.0/aws_sdk_cloudwatchlogs/config/struct.Builder.html#method.retry_config)

mod client;
mod dispatch;
mod export;
mod guard;
mod layer;

pub use client::CloudWatchClient;
pub use dispatch::{CloudWatchDispatcher, NoopDispatcher};
pub use export::{ExportConfig, LogDestination};
pub use guard::CloudWatchWorkerGuard;
pub use layer::{CloudWatchLayer, layer};