Skip to main content

grow_datadog_apm/
lib.rs

1// Skeleton created by sdk-kit 0.1.0; owned by this repository (edit freely).
2//! # grow-datadog-apm
3//!
4//! Rust SDK for [Datadog APM](https://grow-codes-packages.github.io/datadog-apm/) by Grow Codes.
5//!
6//! Two halves:
7//!
8//! - **Tracing** to the local Datadog Agent: [`init_tracing`] (OpenTelemetry, OTLP to the Agent,
9//!   unified service tagging, [`DatadogPropagator`], Datadog error attributes), the id helpers
10//!   ([`to_datadog_trace_id`], …) and log correlation ([`datadog_log_fields`]). The client's
11//!   `health`, `ping` and `server_version` use the Agent's `GET /info`.
12//! - **Query** via the Datadog SaaS API: [`DatadogSpansQuery`] (spans search, aggregate,
13//!   `get_trace`, `list_services`, …; needs `DD_API_KEY` + `DD_APP_KEY`).
14//!
15//! ```no_run
16//! # async fn demo() -> grow_datadog_apm::Result<()> {
17//! use grow_datadog_apm::{datadog_log_fields, tracing::{traced, TracingConfig}, DatadogApmClient};
18//!
19//! let client = DatadogApmClient::from_env()?;
20//! let health = client.health().await?;
21//! println!("healthy: {}", health.healthy);
22//! let tracing = client.init_tracing(TracingConfig::new("checkout"))?;
23//! traced("charge-card", async {
24//!     println!("{:?}", datadog_log_fields(Default::default()));
25//!     Ok::<_, std::io::Error>(())
26//! })
27//! .await
28//! .ok();
29//! client.close().await; // flushes the spans
30//! # Ok(())
31//! # }
32//! ```
33//!
34//! Features: `blocking` (a blocking client), `testing` (in-memory fakes and the conformance
35//! runner)
36//! , `tower` and `reqwest-middleware` (tracing instrumentation)
37//! .
38#![cfg_attr(docsrs, feature(doc_cfg))]
39
40pub mod core;
41
42mod client;
43mod config;
44mod correlation;
45mod ids;
46mod mapping;
47mod propagator;
48mod setup;
49mod sites;
50mod span_errors;
51mod spans;
52mod time;
53
54#[cfg(feature = "blocking")]
55#[cfg_attr(docsrs, doc(cfg(feature = "blocking")))]
56pub mod blocking;
57
58#[cfg(feature = "testing")]
59#[cfg_attr(docsrs, doc(cfg(feature = "testing")))]
60pub mod testing;
61
62pub mod tracing;
63
64pub use crate::core::{Error, ErrorCode, HealthStatus, Result, RetryPolicy, Secret};
65
66pub use crate::client::{AgentInfo, DatadogApmClient};
67pub use crate::config::{
68    otlp_traces_url, parse_datadog_tags, DatadogApmConfig, DatadogApmConfigBuilder,
69    AGENT_TRACE_PORT, DEFAULT_PROTOCOL, DEFAULT_URL, OTLP_GRPC_PORT, OTLP_HTTP_PORT,
70};
71pub use crate::correlation::{
72    datadog_log_fields, set_datadog_log_defaults, DatadogLogFields, DatadogLogFieldsOptions,
73    LOG_FIELD_ENV, LOG_FIELD_SERVICE, LOG_FIELD_SPAN_ID, LOG_FIELD_TRACE_ID, LOG_FIELD_VERSION,
74};
75pub use crate::ids::{
76    datadog_trace_id_string, from_datadog_span_id, from_datadog_trace_id,
77    normalize_datadog_span_id, normalize_datadog_trace_id, to_datadog_span_id, to_datadog_trace_id,
78    trace_id_for_path, DatadogTraceId,
79};
80pub use crate::mapping::{
81    datadog_kind, datadog_search_span_to_span, datadog_trace_span_to_span, RawDatadogSpan,
82};
83pub use crate::propagator::{
84    extract_datadog_context, terminated_context, terminated_context_links, DatadogPropagator,
85    TerminatedContext, DATADOG_ORIGIN_HEADER, DATADOG_PARENT_ID_HEADER,
86    DATADOG_SAMPLING_PRIORITY_HEADER, DATADOG_TAGS_HEADER, DATADOG_TRACE_ID_HEADER,
87    PROPAGATOR_DATADOG,
88};
89pub use crate::setup::{
90    datadog_exporter_factory, init_tracing, init_tracing_with_options, order_propagators,
91    DatadogTracingHandle, InitTracingOptions, DATADOG_DEFAULT_PROPAGATORS,
92};
93pub use crate::sites::{
94    api_url_for_site, is_datadog_site, normalize_site, validate_site, DATADOG_SITES, DEFAULT_SITE,
95};
96pub use crate::span_errors::{
97    datadog_error_attributes, record_datadog_exception, record_exception, set_datadog_error,
98    set_error, set_error_attributes, with_datadog_error_attributes, with_terminated_context_link,
99    DatadogSpanExporter, ATTR_ERROR_MESSAGE, ATTR_ERROR_STACK, ATTR_ERROR_TYPE,
100};
101pub use crate::spans::{
102    aggregation, quote_query_value, trace_search_query_string, AggregateSpansOptions,
103    DatadogQueryWarning, DatadogSpan, DatadogSpansPage, DatadogSpansQuery, DatadogTime,
104    GetTraceOptions, ListServicesOptions, SearchSpansOptions, SpanAggregateBucket,
105    SpanAggregateResult, SpanCompute, SpanComputeValue, SpanGroupBy, SpanGroupBySort,
106    SpanHistogram, SpanTimeseriesPoint, DATADOG_WAIT_INTERVAL,
107};
108
109/// Service-prefixed alias of [`Error`].
110pub type DatadogApmError = Error;