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;
62mod context_builder;
63pub mod datasource;
64pub mod health_registry;
65pub(crate) mod hot_reload;
66pub mod lifecycle;
67pub(crate) mod shared;
68pub mod step;
69pub mod template;
70
71#[cfg(feature = "internal-adapters")]
72pub mod route {
73    pub use crate::lifecycle::adapters::route_compiler::{
74        RouteChannelService, compose_pipeline, compose_pipeline_with_contracts,
75        compose_pipeline_with_handler, compose_traced_pipeline,
76    };
77    pub use crate::lifecycle::adapters::route_types::Route;
78    pub use crate::lifecycle::adapters::step_compilers::CompiledStep;
79    pub use crate::lifecycle::application::route_definition::*;
80    pub use crate::lifecycle::domain::route::RouteSpec;
81}
82
83#[cfg(feature = "internal-adapters")]
84pub mod route_controller {
85    pub use crate::lifecycle::adapters::route_controller::*;
86}
87
88pub mod supervising_route_controller {
89    pub use crate::lifecycle::adapters::controller_actor::spawn_supervision_task;
90}
91
92pub mod reload_watcher {
93    pub use crate::hot_reload::adapters::reload_watcher::*;
94    pub use crate::hot_reload::application::FunctionReloadContext;
95    pub use crate::hot_reload::application::execute_reload_actions;
96    pub use crate::hot_reload::domain::ReloadAction;
97}
98
99pub use crate::hot_reload::adapters::ReloadWatcher;
100pub use crate::hot_reload::application::FunctionReloadContext;
101pub use crate::hot_reload::application::execute_reload_actions;
102pub use crate::hot_reload::domain::ReloadAction;
103pub use crate::lifecycle::adapters::controller_actor::RouteControllerHandle;
104pub use crate::lifecycle::adapters::controller_actor::spawn_controller_actor;
105pub use crate::lifecycle::adapters::controller_actor::spawn_supervision_task;
106#[cfg(feature = "internal-adapters")]
107pub use crate::lifecycle::adapters::exchange_uow::ExchangeUoWLayer;
108#[cfg(feature = "internal-adapters")]
109pub use crate::lifecycle::adapters::redb_journal::{
110    JournalDurability, JournalEntry, JournalInspectFilter, RedbJournalOptions,
111    RedbRuntimeEventJournal,
112};
113#[cfg(feature = "internal-adapters")]
114pub use crate::lifecycle::adapters::route_controller::DefaultRouteController;
115#[cfg(feature = "internal-adapters")]
116pub use crate::lifecycle::adapters::route_types::Route;
117#[cfg(feature = "internal-adapters")]
118pub use crate::lifecycle::adapters::{
119    InMemoryCommandDedup, InMemoryEventPublisher, InMemoryProjectionStore, InMemoryRouteRepository,
120    InMemoryRuntimeStore, RuntimeExecutionAdapter,
121};
122pub use crate::lifecycle::application::runtime_bus::RuntimeBus;
123pub use crate::lifecycle::application::{BuilderStep, RouteDefinition};
124pub use crate::lifecycle::domain::{
125    LanguageRegistryError, RouteLifecycleCommand, RouteRuntimeAggregate, RouteRuntimeState,
126    RuntimeEvent,
127};
128pub use crate::lifecycle::ports::{
129    CommandDedupPort, EventPublisherPort, InFlightCountResult, ProjectionStorePort,
130    RouteRepositoryPort, RouteStatusProjection, RuntimeEventJournalPort, RuntimeExecutionPort,
131    RuntimeUnitOfWorkPort,
132};
133pub use crate::shared::components::domain::Registry;
134pub use crate::shared::observability::adapters::TracingProcessor;
135pub use crate::shared::observability::domain::{
136    DetailLevel, FileOutput, OutputFormat, StdoutOutput, TracerConfig, TracerOutputs,
137};
138pub use context::CamelContext;
139pub use template::TemplateRegistry;
140
141// Re-export route controller types from camel-api (they live there to avoid cyclic dependencies).
142pub use camel_api::CamelError;
143pub use camel_api::{RouteAction, RouteController, RouteStatus};
144
145impl From<lifecycle::domain::DomainError> for CamelError {
146    fn from(e: lifecycle::domain::DomainError) -> Self {
147        CamelError::RouteError(e.to_string())
148    }
149}
150
151impl From<lifecycle::domain::LanguageRegistryError> for CamelError {
152    fn from(e: lifecycle::domain::LanguageRegistryError) -> Self {
153        CamelError::Config(e.to_string())
154    }
155}