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 cache;
62pub mod claim_check;
63pub mod component_metadata_catalog;
64pub mod context;
65mod context_builder;
66pub mod datasource;
67pub mod health_registry;
68pub(crate) mod hot_reload;
69pub mod idempotent;
70pub mod language_registry;
71pub mod lifecycle;
72mod registry;
73// Re-export idempotent registry types for use in lifecycle layers (which
74// are forbidden by the hexagonal boundary test from importing
75// `crate::registry::` directly). Use `crate::IdempotentRegistry` etc.
76pub(crate) use registry::{
77    CacheRegistry, ClaimCheckRegistry, IdempotentRegistry, SharedCacheRegistry,
78    SharedClaimCheckRegistry, SharedIdempotentRegistry,
79};
80pub(crate) mod shared;
81pub mod startup_validation;
82pub mod step;
83pub mod template;
84
85#[cfg(feature = "export-internal-adapters")]
86pub mod route {
87    pub use crate::lifecycle::adapters::route_compiler::{
88        PipelineRuntimeCtx, RouteChannelService, compose_pipeline, compose_pipeline_with_contracts,
89        compose_pipeline_with_handler, compose_traced_pipeline,
90    };
91    pub use crate::lifecycle::adapters::route_types::Route;
92    pub use crate::lifecycle::adapters::step_compilers::CompiledStep;
93    pub use crate::lifecycle::application::route_definition::*;
94    pub use crate::lifecycle::domain::route::RouteSpec;
95}
96
97#[cfg(feature = "export-internal-adapters")]
98pub mod route_controller {
99    pub use crate::lifecycle::adapters::route_controller::*;
100    pub use crate::lifecycle::adapters::route_controller_trait::{
101        BindExposureAcks, enforce_bind_exposure_gate,
102    };
103}
104
105pub mod supervising_route_controller {
106    pub use crate::lifecycle::adapters::controller_actor::spawn_supervision_task;
107}
108
109pub mod reload_watcher {
110    pub use crate::hot_reload::adapters::reload_watcher::*;
111    pub use crate::hot_reload::application::FunctionReloadContext;
112    pub use crate::hot_reload::application::execute_reload_actions;
113    pub use crate::hot_reload::domain::ReloadAction;
114}
115
116pub use crate::hot_reload::adapters::ReloadWatcher;
117pub use crate::hot_reload::application::FunctionReloadContext;
118pub use crate::hot_reload::application::execute_reload_actions;
119pub use crate::hot_reload::domain::ReloadAction;
120#[cfg(feature = "export-internal-adapters")]
121pub use crate::idempotent::RedbIdempotentRepository;
122pub use crate::language_registry::LanguageRegistryError;
123pub use crate::lifecycle::adapters::controller_actor::RouteControllerHandle;
124pub use crate::lifecycle::adapters::controller_actor::spawn_controller_actor;
125pub use crate::lifecycle::adapters::controller_actor::spawn_supervision_task;
126#[cfg(feature = "export-internal-adapters")]
127pub use crate::lifecycle::adapters::exchange_uow::ExchangeUoWLayer;
128#[cfg(feature = "export-internal-adapters")]
129pub use crate::lifecycle::adapters::redb_journal::{
130    JournalDurability, JournalEntry, JournalInspectFilter, RedbJournalOptions,
131    RedbRuntimeEventJournal,
132};
133
134#[cfg(feature = "export-internal-adapters")]
135pub use crate::lifecycle::adapters::route_controller::DefaultRouteController;
136#[cfg(feature = "export-internal-adapters")]
137pub use crate::lifecycle::adapters::route_types::Route;
138#[cfg(feature = "export-internal-adapters")]
139pub use crate::lifecycle::adapters::{
140    InMemoryCommandDedup, InMemoryEventPublisher, InMemoryProjectionStore, InMemoryRouteRepository,
141    InMemoryRuntimeStore, RuntimeExecutionAdapter,
142};
143pub use crate::lifecycle::application::ports::{
144    CommandDedupPort, EventPublisherPort, InFlightCountResult, ProjectionStorePort,
145    RouteRepositoryPort, RouteStatusProjection, RuntimeEventJournalPort, RuntimeExecutionPort,
146    RuntimeUnitOfWorkPort,
147};
148pub use crate::lifecycle::application::runtime_bus::RuntimeBus;
149pub use crate::lifecycle::application::{BuilderStep, RouteDefinition};
150pub use crate::lifecycle::domain::{
151    RouteLifecycleCommand, RouteRuntimeAggregate, RouteRuntimeState, RuntimeEvent,
152};
153pub use crate::shared::components::domain::Registry;
154pub use crate::shared::components::domain::RegistryComponentContext;
155pub use crate::shared::observability::adapters::TracingProcessor;
156pub use crate::shared::observability::domain::{
157    DetailLevel, FileOutput, OutputFormat, StdoutOutput, TracerConfig, TracerOutputs,
158};
159pub use context::CamelContext;
160pub use language_registry::from_config as languages_from_config;
161pub use template::TemplateRegistry;
162
163// Re-export route controller types from camel-api (they live there to avoid cyclic dependencies).
164pub use camel_api::CamelError;
165pub use camel_api::{RouteAction, RouteController, RouteStatus};
166
167impl From<lifecycle::domain::DomainError> for CamelError {
168    fn from(e: lifecycle::domain::DomainError) -> Self {
169        CamelError::RouteError(e.to_string())
170    }
171}
172
173impl From<crate::language_registry::LanguageRegistryError> for CamelError {
174    fn from(e: crate::language_registry::LanguageRegistryError) -> Self {
175        CamelError::Config(e.to_string())
176    }
177}
camel_core/lib.rs

camel_core/
lib.rs
