Skip to main content

grow_datadog_logs/
lib.rs

1// Skeleton created by sdk-kit 0.1.0; owned by this repository (edit freely).
2//! # grow-datadog-logs
3//!
4//! Rust SDK for [Datadog Log Management](https://grow-codes-packages.github.io/datadog-logs/) by
5//! Grow Codes: the logs intake (`POST /api/v2/logs`, gzip, 1000 entries / 5 MB batches, 1 MB per
6//! log), Logs Search v2 with cursor pagination, log aggregation, index listing and API key checks.
7//! Not affiliated with Datadog, Inc.
8//!
9//! ```no_run
10//! # async fn demo() -> grow_datadog_logs::Result<()> {
11//! use grow_datadog_logs::logging::{attrs, LogClient};
12//! use grow_datadog_logs::{DatadogLogsClient, DatadogLogsConfig, LogClientOptions};
13//!
14//! // DD_API_KEY, DD_SITE, DD_SERVICE, … or GROW_DATADOG_LOGS_* variables
15//! let client = DatadogLogsClient::new(DatadogLogsConfig::from_env()?)?;
16//! assert!(client.validate_api_key().await?);
17//! let logs = client.log_client(LogClientOptions::default())?;
18//! logs.logger(Some("checkout"), attrs! {}).info("order placed", attrs! { "order.id" => 42 });
19//! client.close().await; // flushes
20//! # Ok(())
21//! # }
22//! ```
23//!
24//! Search (needs `DD_APP_KEY`):
25//!
26//! ```no_run
27//! # async fn demo(client: grow_datadog_logs::DatadogLogsClient) -> grow_datadog_logs::Result<()> {
28//! use grow_datadog_logs::SearchLogsRequest;
29//! let query = client.query()?;
30//! let page = query
31//!     .search_logs(&SearchLogsRequest::new("service:checkout status:error").from("now-1h").limit(50))
32//!     .await?;
33//! for record in page.records() {
34//!     println!("{} {}", record.severity, record.body);
35//! }
36//! # Ok(())
37//! # }
38//! ```
39//!
40//! Features: `blocking` (a blocking client), `testing` (in-memory fakes and the conformance
41//! runner), `tracing-layer` and `log-bridge` (logging adapters, on by default).
42#![cfg_attr(docsrs, feature(doc_cfg))]
43
44pub mod core;
45
46mod client;
47mod config;
48mod http;
49mod intake;
50pub mod mapping;
51pub mod query;
52
53#[cfg(feature = "blocking")]
54#[cfg_attr(docsrs, doc(cfg(feature = "blocking")))]
55pub mod blocking;
56
57#[cfg(feature = "testing")]
58#[cfg_attr(docsrs, doc(cfg(feature = "testing")))]
59pub mod testing;
60
61pub mod logging;
62
63pub use crate::core::{Error, ErrorCode, HealthStatus, Result, RetryPolicy, Secret};
64
65pub use crate::client::{DatadogLogClient, DatadogLogsClient, LogClientOptions, VALIDATE_PATH};
66pub use crate::config::{
67    parse_tags, resolve_site, DatadogLogsConfig, DatadogLogsConfigBuilder, SiteEndpoints,
68    DEFAULT_INTAKE_URL, DEFAULT_SITE, DEFAULT_SOURCE, DEFAULT_URL, SITES,
69};
70pub use crate::http::{map_datadog_error, HEADER_API_KEY, HEADER_APP_KEY, RATE_LIMIT_RESET_HEADER};
71pub use crate::intake::{DatadogLogExporter, EncodedBatch, IntakePayload, INTAKE_PATH};
72pub use crate::mapping::LogEvent;
73pub use crate::query::{
74    AggregateBucket, AggregateLogsOptions, AggregateLogsResult, Compute, DatadogLogsQuery, GroupBy,
75    GroupByHistogram, GroupBySort, LogIndex, LogsSort, QueryMeta, SearchLogsPage,
76    SearchLogsRequest, SearchWarning, TimeseriesPoint,
77};
78
79/// Service-prefixed alias of [`Error`].
80pub type DatadogLogsError = Error;