Monitoring Red Hat Integration

Procedure

1. Login to OpenShift with administrator permissions:

   $ oc login -u system:admin

2. Install the custom resource definitions necessary for running the Prometheus operator, where {$templates-base-url} is the location of the Fuse on OpenShift template files:

   $ oc create -f {$templates-base-url}\fuse-prometheus-crd.yml

   The Prometheus operator is now available to any namespace on the cluster.

3. Install the Prometheus operator to your namespace by using the following command syntax:

   $ oc process -f {$templates-base-url}/fuse-prometheus-operator.yml -p NAMESPACE=<YOUR NAMESPACE> | oc create -f -

   For example, use this command for a project (namespace) named myproject:

   oc process -f {$templates-base-url}/fuse-prometheus-operator.yml -p NAMESPACE=myproject | oc create -f -

   Note

   The first time that you install the Prometheus operator into a namespace, it might take a few minutes for the Prometheus resource pods to start. Subsequently, if you install it to other namespaces on your cluster, the Prometheus resource pods start much faster.

4. Instruct the Prometheus operator to monitor the Fuse application in the project by using the following command syntax::

   $ oc process -f {$templates-base-url}/fuse-servicemonitor.yml -p NAMESPACE=<YOUR NAMESPACE> -p FUSE_SERVICE_NAME=<YOUR FUSE SERVICE> | oc apply -f -

   For example, use this command for an OpenShift project (namespace) named myproject that includes a Fuse application named myfuseapp:

   oc process -f {$templates-base-url}/fuse-servicemonitor.yml -p NAMESPACE=myproject -p FUSE_SERVICE_NAME=myfuseapp | oc apply -f -

5. To open the Prometheus dashboard:

   1. Login to the OpenShift console.
   2. Open the project to which you added Prometheus.

   3. In the left pane, select Applications → Routes.

      

   4. Click the Prometheus Hostname URL to open the Prometheus dashboard in a new browser tab or window.

      

   5. For information about getting started with Prometheus, go to: https://prometheus.io/docs/prometheus/latest/getting_started/

1. Create a custom Prometheus configuration file. You can use the contents of the default file (prometheus-config.yml https://raw.githubusercontent.com/jboss-fuse/application-templates/master/prometheus/prometheus-config.yml) as a guide for the format.

   You can use any name for the custom configuration file, for example: my-prometheus-config.yml.

2. Add your prometheus configuration file (for example, my-prometheus-config.yml) to your application’s src/main/fabric8-includes directory.

3. Create a src/main/fabric8/deployment.xml file within your application and add an entry for the AB_JMX_EXPORTER_CONFIG environment variable with its value set to your configuration file. For example:

   spec:
     template:
       spec:
         containers:
           -
             resources:
               requests:
                 cpu: "0.2"
               limits:
                 cpu: "1.0"
             env:
             - name: SPRING_APPLICATION_JSON
               value: '{"server":{"tomcat":{"max-threads":1}}}'
             - name: AB_JMX_EXPORTER_CONFIG
               value: "my-prometheus-config.yml"

   This environment variable applies to your application at the pod level.

4. Rebuild and deploy your application.

Procedure

1. In the Fuse Online namespace, set the monitoring-key=middleware label by using the following command:

   oc label namespace <fuse-online-namespace> monitoring-key=middleware

2. Verify that your Fuse Online installation added the application monitoring configuration resources to the OpenShift cluster:

   1. In the OpenShift web console, go to the applicaton-monitoring project and then open the prometheus-route URL.

   2. In the Prometheus console, go to the Status → Targets page.

      If a Syndesis target is listed, then Fuse Online is configured for monitoring and you can skip to Step 4.

      If a Syndesis target is not listed, continue to Step 3.

3. If the infrastructure resources are not on the OpenShift cluster, to enable Prometheus monitoring:

   1. Go to the Fuse Online namespace:

      OpenShift 4.x	OpenShift 3.11
      In the OpenShift web console, go to the Fuse Online (syndesis) project. Select Catalog > Installed Operators and then click Fuse Online Operator. Click Syndesis CRD and then click app. Click Yaml to open the yaml file in the editor.	Select Resources > Other Resources. From the dropdown menu, select the Syndesis resources type. For the app resource, click Actions and then select Edit YAML to open the yaml file in the editor.

   2. Edit the yaml file to set the Syndesis.Spec.Addons.Ops.Enable value to true by adding the follow lines:

      spec:
        addons:
          ops:
            enabled: "true"

   3. Save the file.

   4. Wait for the pod to restart.

      Note

      The infrastructure resources are not available immediately after you run the install commands. You might need to wait before you can see the Fuse Online (Syndesis) targets in the Prometheus Targets page.

4. To access Prometheus:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.
   2. Next to the prometheus-route entry, click the hostname URL to open the Prometheus console.
   3. To view a list of the alert rules configured for Fuse Online infrastructure components, click the Alerts menu item.

5. To access Grafana dashboards:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.
   2. Next to the grafana-route entry, click the hostname URL to open the Grafana console.

   3. At the top of the Grafana console, click the dashboard selector and then select one of the following infrastructure dashboards:

      Infrastructure - DB

      Displays metrics related to the Fuse Online Postgres instance.

      Infrastructure - JVM

      Displays metrics about the running JVM for the syndesis-meta or syndesis-server applications. Chose the application that you want to monitor from the Application drop down list at the top of the dashboard.

      Infrastructure - REST APIs

      Displays metrics relating to the Fuse Online infrastructure API endpoints, such as request throughput and latency. Chose the application that you want to monitor from the Application drop down list at the top of the dashboard.

6. To access Prometheus Alertmanager:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.

   2. Next to the alertmanager-route entry, click the hostname URL to open the Alertmanager console.

      If the Fuse Online infrastructure is healthy, the default view is empty.

      If any of the infrastructure components are unhealthy, any active alerts that have been fired are listed, along with the option to silence them.

Procedure

1. In the Fuse Online namespace, set the monitoring-key=middleware label by using the following command:

   oc label namespace <fuse-online-namespace> monitoring-key=middleware

2. Verify that your Fuse Online installation added the application monitoring configuration resources to the OpenShift cluster.

   1. In the OpenShift web console, go to the applicaton-monitoring project and then open the prometheus-route URL.

   2. In the Prometheus console, go to the Status > Targets page.

      If a Syndesis target is listed, then Fuse Online has been configured for monitoring and you can skip to Step 4.

      If a Syndesis target is not listed, continue to Step 3.

3. If the infrastructure resources are not on the OpenShift cluster, to enable Prometheus monitoring:

   1. Go to the Fuse Online namespace:

      OpenShift 4.x	OpenShift 3.11
      In the OpenShift web console, go to the Fuse Online (syndesis) project. Select Catalog > Installed Operators and then click Fuse Online Operator. Click Syndesis CRD and then click app. Click Yaml to open the yaml file in the editor.	Select Resources > Other Resources. From the dropdown menu, select the Syndesis resources type. For the app resource, click Actions and then select Edit YAML to open the yaml file in the editor.

   2. Edit the yaml file to set the Syndesis.Spec.Addons.Ops.Enable value to true by adding the follow lines:

      spec:
        addons:
          ops:
            enabled: "true"

   3. Save the file.

   4. Wait for the pod to restart.

      Note

      The infrastructure resources are not available immediately after you run the install commands. You might need to wait before you can see the Fuse Online (Syndesis) targets in the Prometheus Targets page.

4. To access Prometheus:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.
   2. Next to the prometheus-route entry, click the hostname URL to open the Prometheus console.
   3. To view a list of the alert rules configured for Fuse Online infrastructure components, clicking the Alerts menu item.

5. To access a Grafana dashboard:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.
   2. Next to the grafana-route entry, click the hostname URL to open the Grafana console.

   3. At the top of the Grafana console, click the dashboard selector and then select Integration - Camel.

      This dashboard displays the standard metrics exposed by Apache Camel integration applications.