This is an automated email from the ASF dual-hosted git repository. pcongiusti pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 73c5cb95125553e9e770ce399e6d9089c4ff00eb Author: Pasquale Congiusti <pasquale.congiu...@gmail.com> AuthorDate: Thu Apr 24 11:31:17 2025 +0200 chore(doc): management port --- .../src/main/docs/observability-services.adoc | 4 ++++ .../modules/ROOT/pages/camel-4x-upgrade-guide-4_12.adoc | 9 ++++++++- docs/user-manual/modules/ROOT/pages/health-check.adoc | 6 +++--- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/components/camel-observability-services/src/main/docs/observability-services.adoc b/components/camel-observability-services/src/main/docs/observability-services.adoc index 52eae3d71c2..109e73acf4a 100644 --- a/components/camel-observability-services/src/main/docs/observability-services.adoc +++ b/components/camel-observability-services/src/main/docs/observability-services.adoc @@ -52,6 +52,10 @@ The presence of this dependency will expose the following endpoints: |==== +The endpoints are exposed in the management port (default `9876`) in order to avoid interfering with the regular business running on any other port. + +NOTE: the management port is available since version 4.12.0. In previous version the endpoints were exposed in the regular business port (default `8080`). + == OpenTelemetry configuration The presence of this component will provide the required instrumentation to easily enable the collection of OpenTelemetry metrics. diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_12.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_12.adoc index 26294c1f562..912e783feb1 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_12.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_12.adoc @@ -31,7 +31,7 @@ will now also propagate exchange variables as well into the result (i.e. exchang Using type converters that has been marked to allow null via (`@Converter(allow-null = true)`) has been improved to allow returning `null` as a positive answer when using `convertBodyTo` EIP and `mandatoryConvertTo` or `getMandatoryBody` etc. -This behaviour was present in Camel v2 and some internal optimization in Camel v3 had changed +This behavior was present in Camel v2 and some internal optimization in Camel v3 had changed this to not be the case. Using type converters that can return `null` is a rare use-case, and it's not a good practice. === Java DSL @@ -95,3 +95,10 @@ asynchronous MDN requests. The `tags` parameter has been _fixed_ to be multivalued and tooling friendly. So instead of configuring `tags=a=1&b=2` then this should be configured as `tags.a=1&tags.b=2` and so forth. +=== camel-main + +We have introduced the possibility to use a management server where to expose management endpoints (such as health, metrics, etcetera). The new server will be available by default on port `9876`. This and other several configuration can be changed using `camel.management` application properties group. In order to avoid breaking compatibility, the previous services running on business port (default `8080`) will be still running on the old port AND on the new port for a few future releases [...] + +=== camel-observability-services + +As seen in `camel-main` change, the component is now adopting the new management port to expose its services. However, it will be still possible to use also the old port to avoid introducing any breaking compatibility. Mind that this possibility will be removed in future versions. \ No newline at end of file diff --git a/docs/user-manual/modules/ROOT/pages/health-check.adoc b/docs/user-manual/modules/ROOT/pages/health-check.adoc index 5fe4f1d2024..0ff8e4436ca 100644 --- a/docs/user-manual/modules/ROOT/pages/health-check.adoc +++ b/docs/user-manual/modules/ROOT/pages/health-check.adoc @@ -103,7 +103,7 @@ if (consumersHealthCheckRepository != null) { Once you have the health check exposed as a service and the application is up and running, you can check it by accessing the related endpoint: ``` -$ curl http://localhost:8080/q/health +$ curl http://localhost:9876/observe/health { "status": "UP" , @@ -121,12 +121,12 @@ $ curl http://localhost:8080/q/health } ``` -NOTE: the path can change depending on the runtime used and the configuration. +NOTE: the port and the path can change depending on the runtime used and the configuration. When you're running on certain runtimes you will get more information by default. This is also possible in the `camel-main` runtime provider. However, you'll need to specify that as a request parameter: ``` -$ curl http://localhost:8080/q/health?data=true +$ curl http://localhost:9876/observe/health?data=true { "status": "UP" ,