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

camel_core/
lib.rs
