This is an automated email from the ASF dual-hosted git repository.
ppalaga pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 4153eacafea47016ee05bbab6e829da13d80344b
Author: Peter Palaga <ppal...@redhat.com>
AuthorDate: Mon Aug 24 18:07:14 2020 +0200
Docs: better intro, observability. Substantial parts taken from
https://jamesnetherton.github.io/2020/08/12/camel-quarkus-1.0.0-released/
---
docs/modules/ROOT/nav.adoc | 1 +
docs/modules/ROOT/pages/index.adoc | 19 ++++++++++--
.../ROOT/pages/user-guide/observability.adoc | 36 ++++++++++++++++++++++
3 files changed, 53 insertions(+), 3 deletions(-)
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
index 644a1da..60fe25a 100644
--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@@ -2,6 +2,7 @@
** xref:user-guide/first-steps.adoc[First steps]
** xref:user-guide/bootstrap.adoc[Bootstrap]
** xref:user-guide/cdi.adoc[CDI]
+** xref:user-guide/observability.adoc[Observability]
** xref:user-guide/native-mode.adoc[Native mode]
** xref:user-guide/examples.adoc[Examples]
* xref:contributor-guide/index.adoc[Contributor guide]
diff --git a/docs/modules/ROOT/pages/index.adoc
b/docs/modules/ROOT/pages/index.adoc
index c3094b0..abc039a 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -1,7 +1,20 @@
= Apache Camel extensions for Quarkus
-This project hosts the efforts to port and package the 280+ Camel components
as Quarkus extensions.
+This project aims to bring the awesome integration capabilities of
https://camel.apache.org/manual/latest/[Apache Camel]
+and its vast https://camel.apache.org/components/latest/[component library] to
the
+https://quarkus.io/[Quarkus runtime].
-https://quarkus.io/[Quarkus] is a Java platform offering fast boot times and
low memory footprint. It targets both stock JVMs (OpenJDK in the first place)
and https://www.graalvm.org/[GraalVM].
+This enables users to take advantage of the performance benefits,
https://quarkus.io/vision/developer-joy[developer joy]
+and the https://quarkus.io/vision/container-first[container first ethos] that
Quarkus provides.
-https://quarkus.io/extensions/[Quarkus extensions] are units of Quarkus
distribution. They configure, boot and integrate a technology (in our case
Camel components) into your Quarkus application. You will typically use them as
dependencies in your project.
+Camel Quarkus provides xref:reference/index.adoc[Quarkus extensions] for many
of the Camel components.
+
+Camel Quarkus also takes advantage of the many performance improvements made
in Camel 3, which results in a lower memory footprint, less reliance on
reflection (which is good for native application support) and faster startup
times.
+
+You can define Camel routes using the Java DSL, XML & Kotlin (see the
xref:user-guide/examples.adoc[examples]).
+
+=== Where to go next?
+
+* xref:user-guide/index.adoc[User guide]
+* xref:contributor-guide/index.adoc[Contributor guide]
+* xref:reference/index.adoc[Extensions reference]
diff --git a/docs/modules/ROOT/pages/user-guide/observability.adoc
b/docs/modules/ROOT/pages/user-guide/observability.adoc
new file mode 100644
index 0000000..ed24eba
--- /dev/null
+++ b/docs/modules/ROOT/pages/user-guide/observability.adoc
@@ -0,0 +1,36 @@
+= Observability
+
+== Health & liveness checks
+
+Health & liveness checks are supported via the
+xref:reference/extensions/microprofile-health.html[MicroProfile Health]
extension. They can be configured via the
+https://camel.apache.org/manual/latest/health-check.html[Camel Health] API or
via
+https://quarkus.io/guides/microprofile-health[Quarkus MicroProfile Health].
+
+All configured checks are available on the standard MicroProfile Health
endpoint URLs:
+
+* http://localhost:8080/health
+* http://localhost:8080/health/live
+* http://localhost:8080/health/ready
+
+There's an example project which demonstrates health checks:
https://github.com/apache/camel-quarkus/tree/master/examples/health
+
+== Metrics
+
+We provide the
xref:reference/extensions/microprofile-metrics.html[MicroProfile Metrics]
extension which integrates with
+https://quarkus.io/guides/microprofile-metrics[Quarkus MicroProfile Metrics]
under the hood. Some basic Camel metrics
+are provided for you out of the box, and these can be supplemented by
configuring additional metrics in your routes.
+
+Metrics are available on the standard MicroProfile metrics endpoint:
+
+* http://localhost:8080/metrics
+
+== Tracing
+
+xref:reference/extensions/opentracing.html[Camel Quarkus OpenTracing
extension] integrates with the
+https://quarkus.io/guides/opentracing[Quarkus OpenTracing extension]. All you
need to do is set up the required
+https://quarkus.io/guides/opentracing#create-the-configuration[configuration]
properties and an `OpenTracingTracer`
+will get automatically added to the registry for Camel to use.
+
+There's an example project demonstrating the above features here:
+https://github.com/apache/camel-quarkus/tree/master/examples/observability
