Skip to main content

camel_core/
lib.rs

1//! # Camel Core
2//!
3//! This crate provides the core functionality for the Apache Camel implementation in Rust.
4//!
5//! ## Tracer EIP
6//!
7//! The Tracer Enterprise Integration Pattern (EIP) provides automatic message flow tracing
8//! throughout your Camel routes. It captures detailed information about each step as messages
9//! flow through the integration routes, helping with debugging, monitoring, and observability.
10//!
11//! ### Configuration
12//!
13//! You can configure the tracer in your `Camel.toml` file:
14//!
15//! ```toml
16//! [observability.tracer]
17//! enabled = true
18//! detail_level = "minimal"  # minimal | medium | full
19//!
20//! [observability.tracer.outputs.stdout]
21//! enabled = true
22//! format = "json"
23//! ```
24//!
25//! Or enable it programmatically:
26//!
27//! ```ignore
28//! use camel_core::CamelContext;
29//! let mut ctx = CamelContext::builder().build().await.unwrap();
30//! ctx.set_tracing(true).await;
31//! ```
32//!
33//! ### Span Fields
34//!
35//! Each trace span includes the following fields:
36//!
37//! - `correlation_id`: Unique identifier that links all spans in a single message flow
38//! - `route_id`: Identifier for the route being traced
39//! - `step_id`: Unique identifier for this specific step in the route
40//! - `step_index`: Sequential index of this step within the route
41//! - `timestamp`: When the step was executed (Unix timestamp)
42//! - `duration_ms`: How long the step took to execute in milliseconds
43//! - `status`: The status of the step execution (e.g., "success", "error")
44//!
45//! ### Detail Levels
46//!
47//! The tracer supports three levels of detail:
48//!
49//! - **Minimal**: Includes only the base fields listed above
50//! - **Medium**: Includes the base fields plus:
51//!   - `headers_count`: Number of message headers
52//!   - `body_type`: Type of the message body
53//!   - `has_error`: Whether the message contains an error
54//!   - `output_body_type`: Type of the output body after processing
55//! - **Full**: Includes all fields from Minimal and Medium plus:
56//!   - Up to 3 message headers (`header_0`, `header_1`, `header_2`)
57//!
58//! //! Configuration types for the Tracer EIP live in `camel-core` rather than `camel-config`
59//! //! to avoid a circular dependency — `camel-config` depends on `camel-core`.
60//!
61pub mod context;
62pub(crate) mod hot_reload;
63pub mod lifecycle;
64pub(crate) mod shared;
65pub mod step;
66
67#[cfg(feature = "internal-adapters")]
68pub mod route {
69    pub use crate::lifecycle::adapters::route_compiler::{
70        compose_pipeline, compose_pipeline_with_contracts, compose_traced_pipeline,
71    };
72    pub use crate::lifecycle::adapters::route_types::Route;
73    pub use crate::lifecycle::application::route_definition::*;
74    pub use crate::lifecycle::domain::route::RouteSpec;
75}
76
77#[cfg(feature = "internal-adapters")]
78pub mod route_controller {
79    pub use crate::lifecycle::adapters::route_controller::*;
80}
81
82pub mod supervising_route_controller {
83    pub use crate::lifecycle::adapters::controller_actor::spawn_supervision_task;
84}
85
86pub mod reload_watcher {
87    pub use crate::hot_reload::adapters::reload_watcher::*;
88    pub use crate::hot_reload::application::FunctionReloadContext;
89    pub use crate::hot_reload::application::execute_reload_actions;
90    pub use crate::hot_reload::domain::ReloadAction;
91}
92
93pub use crate::hot_reload::adapters::ReloadWatcher;
94pub use crate::hot_reload::application::FunctionReloadContext;
95pub use crate::hot_reload::application::execute_reload_actions;
96pub use crate::hot_reload::domain::ReloadAction;
97pub use crate::lifecycle::adapters::controller_actor::RouteControllerHandle;
98pub use crate::lifecycle::adapters::controller_actor::spawn_controller_actor;
99pub use crate::lifecycle::adapters::controller_actor::spawn_supervision_task;
100#[cfg(feature = "internal-adapters")]
101pub use crate::lifecycle::adapters::exchange_uow::ExchangeUoWLayer;
102#[cfg(feature = "internal-adapters")]
103pub use crate::lifecycle::adapters::redb_journal::{
104    JournalDurability, JournalEntry, JournalInspectFilter, RedbJournalOptions,
105    RedbRuntimeEventJournal,
106};
107#[cfg(feature = "internal-adapters")]
108pub use crate::lifecycle::adapters::route_controller::DefaultRouteController;
109#[cfg(feature = "internal-adapters")]
110pub use crate::lifecycle::adapters::route_types::Route;
111#[cfg(feature = "internal-adapters")]
112pub use crate::lifecycle::adapters::{
113    InMemoryCommandDedup, InMemoryEventPublisher, InMemoryProjectionStore, InMemoryRouteRepository,
114    InMemoryRuntimeStore, RuntimeExecutionAdapter,
115};
116pub use crate::lifecycle::application::runtime_bus::RuntimeBus;
117pub use crate::lifecycle::application::{BuilderStep, RouteDefinition};
118pub use crate::lifecycle::domain::{
119    LanguageRegistryError, RouteLifecycleCommand, RouteRuntimeAggregate, RouteRuntimeState,
120    RuntimeEvent,
121};
122pub use crate::lifecycle::ports::{
123    CommandDedupPort, EventPublisherPort, InFlightCountResult, ProjectionStorePort,
124    RouteRepositoryPort, RouteStatusProjection, RuntimeEventJournalPort, RuntimeExecutionPort,
125    RuntimeUnitOfWorkPort,
126};
127pub use crate::shared::components::domain::Registry;
128pub use crate::shared::observability::adapters::TracingProcessor;
129pub use crate::shared::observability::domain::{
130    DetailLevel, FileOutput, OutputFormat, StdoutOutput, TracerConfig, TracerOutputs,
131};
132pub use context::CamelContext;
133
134// Re-export route controller types from camel-api (they live there to avoid cyclic dependencies).
135pub use camel_api::CamelError;
136pub use camel_api::{RouteAction, RouteController, RouteStatus};
137
138impl From<lifecycle::domain::DomainError> for CamelError {
139    fn from(e: lifecycle::domain::DomainError) -> Self {
140        CamelError::RouteError(e.to_string())
141    }
142}
143
144impl From<lifecycle::domain::LanguageRegistryError> for CamelError {
145    fn from(e: lifecycle::domain::LanguageRegistryError) -> Self {
146        CamelError::Config(e.to_string())
147    }
148}