gansheer commented on code in PR #6500: URL: https://github.com/apache/camel-k/pull/6500#discussion_r2818092330
########## docs/modules/ROOT/pages/observability/dashboard.adoc: ########## @@ -0,0 +1,47 @@ += Camel Dashboard + +https://camel-tooling.github.io/camel-dashboard/[Camel Dashboard] is a Kubernetes operator that you can use to monitor your fleet of Camel applications deployed in a Kubernetes cluster. Whether you use Camel K to deploy or not, the Dashboard is a great tool that you can use to monitor your Camel fleet. + +NOTE: the project is in developer preview mode. + +The Camel Dashboard was originally born as a spin off from Camel K Synthetic Integrations features and matured into a brand new operator whose goal is to provide a meaningful set of information about typical KPIs of your fleet of Camel workloads running on the cloud. + +From Camel K version 2.10.0 onward, the applications deployed by the operator will be automatically instructed with the labels required by the Dashboard to discover and monitor. This is controlled via a Kubernetes label injected to the Deployments (or CronJob or KnativeService) configured on the operator side with the environment variable `CAMEL_DASHBOARD_APP_LABEL` (set by default to `camel.apache.org/app`). + +On the Camel Dashboard side, any application containing the label will be watched and monitored providing a set of useful Camel metrics (for example, health, number of exchanges succeeded, failed, ...). The information will be stored in a Custom Resource provided by the Camel Dashboard installation procedure: `CamelApp`. Here a basic example: + +```bash +$ kubectl get camelapps -w + +NAME PHASE LAST EXCHANGE EXCHANGE SLI IMAGE REPLICAS INFO +... +camel-app-413 Running 8m32s OK squakez/cdb:4.13 1 Main - 4.13.0-SNAPSHOT (4.13.0-SNAPSHOT) +camel-app-main Running OK docker.io/squakez/db-app-main:1.0 1 Main - 4.11.0 (4.11.0) +camel-app-quarkus Running Warning docker.io/squakez/db-app-quarkus:1.0 1 +camel-app-sb Running Error docker.io/squakez/db-app-sb:1.0 1 Spring-Boot - 3.4.3 (4.11.0) +``` + +You will need to include the `camel-observability-services` component into your application in order to get the full power of this monitoring tool. As an example: Review Comment: Mayeb it's a little late in the documentation. It could benefit to be further up. ########## docs/modules/ROOT/pages/observability/dashboard.adoc: ########## @@ -0,0 +1,47 @@ += Camel Dashboard + +https://camel-tooling.github.io/camel-dashboard/[Camel Dashboard] is a Kubernetes operator that you can use to monitor your fleet of Camel applications deployed in a Kubernetes cluster. Whether you use Camel K to deploy or not, the Dashboard is a great tool that you can use to monitor your Camel fleet. + +NOTE: the project is in developer preview mode. + +The Camel Dashboard was originally born as a spin off from Camel K Synthetic Integrations features and matured into a brand new operator whose goal is to provide a meaningful set of information about typical KPIs of your fleet of Camel workloads running on the cloud. + +From Camel K version 2.10.0 onward, the applications deployed by the operator will be automatically instructed with the labels required by the Dashboard to discover and monitor. This is controlled via a Kubernetes label injected to the Deployments (or CronJob or KnativeService) configured on the operator side with the environment variable `CAMEL_DASHBOARD_APP_LABEL` (set by default to `camel.apache.org/app`). + +On the Camel Dashboard side, any application containing the label will be watched and monitored providing a set of useful Camel metrics (for example, health, number of exchanges succeeded, failed, ...). The information will be stored in a Custom Resource provided by the Camel Dashboard installation procedure: `CamelApp`. Here a basic example: + +```bash +$ kubectl get camelapps -w + +NAME PHASE LAST EXCHANGE EXCHANGE SLI IMAGE REPLICAS INFO +... +camel-app-413 Running 8m32s OK squakez/cdb:4.13 1 Main - 4.13.0-SNAPSHOT (4.13.0-SNAPSHOT) +camel-app-main Running OK docker.io/squakez/db-app-main:1.0 1 Main - 4.11.0 (4.11.0) +camel-app-quarkus Running Warning docker.io/squakez/db-app-quarkus:1.0 1 +camel-app-sb Running Error docker.io/squakez/db-app-sb:1.0 1 Spring-Boot - 3.4.3 (4.11.0) +``` + +You will need to include the `camel-observability-services` component into your application in order to get the full power of this monitoring tool. As an example: Review Comment: Maybe it's a little late in the documentation. It could benefit to be further up. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
