You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "ammachado (via GitHub)" <gi...@apache.org> on 2026/06/16 19:37:16 UTC
[PR] CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs [camel]
ammachado opened a new pull request, #24060:
URL: https://github.com/apache/camel/pull/24060
# Description
Continues the systematic Javadoc improvement of `core/camel-api` started in CAMEL-23535.
This PR adds comprehensive class-level Javadoc to 19 SPI types across three logical batches:
**Batch 13 — JMX Management SPIs**
`ManagementAgent`, `ManagementStrategy`, `ManagementStrategyFactory`, `ManagementNameStrategy`,
`ManagementObjectStrategy`, `ManagementObjectNameStrategy`, `ManagementMBeanAssembler`,
`ManagementInterceptStrategy`
Documents the two-level management design (strategy = high-level coordinator, agent = low-level JMX bridge),
the ObjectName construction pipeline, and the instrumentation wrapping used for EIP statistics collection.
**Batch 14 — Threading and Scheduling SPIs**
`ExecutorServiceManager`, `ThreadPoolProfile`, `ThreadPoolFactory`, `BackOffTimerFactory`,
`ScheduledPollConsumerScheduler`, `ReactiveExecutor`
Documents the layering between the high-level manager (Camel concepts: profiles, naming, lifecycle)
and the low-level factory (pure JDK types, designed for JEE WorkManager substitution), plus the
reactive executor's async dispatch model.
**Batch 15 — Observability SPIs**
`EventNotifier`, `EventFactory`, `Tracer`, `CamelLogger`, `CamelMDCService`
Documents the producer/consumer split between `EventFactory` (mints event objects) and `EventNotifier`
(reacts to them), the `Tracer` before/after node interception model and standby mode, and
`CamelMDCService`'s role in propagating MDC context across async continuation threads.
All types now include at least one link to the relevant Camel user manual page and `@see` cross-references
to related sibling types. No method signatures, annotations, or non-Javadoc code were changed.
# Target
- [x] I checked that the commit is targeting the correct branch (Camel 4 uses the `main` branch)
# Tracking
- [x] If this is a large change, bug fix, or code improvement, I checked there is a [JIRA issue](https://issues.apache.org/jira/browse/CAMEL-23535) filed for the change (usually before you start working on it).
# Apache Camel coding standards and style
- [x] I checked that each commit in the pull request has a meaningful subject line and body.
- [x] I have run `mvn clean install -DskipTests` locally from root folder and I have committed all auto-generated changes.
_Claude Code on behalf of Adriano Machado_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24060:
URL: https://github.com/apache/camel/pull/24060#issuecomment-4723021527
<!-- ci-tested-modules -->
:test_tube: **CI tested the following changed modules:**
- `core/camel-api`
> :information_source: Dependent modules were not tested because the total number of affected modules exceeded the threshold (50). Use the `test-dependents` label to force testing all dependents.
---
:gear: [View full build and test results](https://github.com/apache/camel/actions/runs/27643219335)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus commented on code in PR #24060:
URL: https://github.com/apache/camel/pull/24060#discussion_r3425907302
##########
core/camel-api/src/main/java/org/apache/camel/spi/CamelMDCService.java:
##########
@@ -20,7 +20,20 @@
import org.apache.camel.Service;
/**
- * A Camel MDC service is a factory for Mapped Diagnostic Context service.
+ * SPI that plugs a Mapped Diagnostic Context (MDC) propagation implementation into Camel's exchange processing
+ * pipeline.
+ * <p/>
+ * SLF4J's MDC is thread-local, which means MDC values set on the originating thread are not automatically visible on
+ * continuation threads used by Camel's async routing engine. Implementations of this service are responsible for
+ * capturing the current MDC state when an exchange begins processing and restoring it on each continuation thread, so
+ * that log entries produced across async boundaries carry the same contextual key-value pairs (e.g.,
+ * {@code camel.exchangeId}, {@code camel.routeId}, custom breadcrumb values).
+ * <p/>
Review Comment:
The class `DefaultCamelMDCService` does not exist in the codebase. The actual implementation is `org.apache.camel.mdc.MDCService` in the `components/camel-mdc` module (resolved via `FactoryFinder` with key `camel-mdc`).
The module location (`camel-core-engine`) is also incorrect — it lives in `components/camel-mdc`.
```suggestion
* Camel discovers the implementation via the service registry; the default implementation is
* {@code MDCService} in {@code camel-mdc}. The {@link org.apache.camel.CamelContext} starts and
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24060:
URL: https://github.com/apache/camel/pull/24060#issuecomment-4722853977
:star2: Thank you for your contribution to the Apache Camel project! :star2:
:robot: CI automation will test this PR automatically.
:camel: Apache Camel Committers, please review the following items:
* First-time contributors **require MANUAL approval** for the GitHub Actions to run
* You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot although they are normally detected and executed by CI.
* You can label PRs using `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
* Build and test logs are available in the summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary.
:warning: Be careful when sharing logs. Review their contents before sharing them publicly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #24060:
URL: https://github.com/apache/camel/pull/24060
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org