Visit Azul.com Support

Monitoring Cloud Native Compiler

Table of Contents
Need help?
Schedule a consultation with an Azul performance expert.
Contact Us

You can monitor your Cloud Native Compiler using the standard Kubernetes monitoring tools: Prometheus and Grafana. Cloud Native Compiler service components are already configured to expose key metrics for scraping by Prometheus.

In your production systems, you will likely want to use your existing Prometheus and Grafana instances to monitor Cloud Native Compiler. When your are just evaluating Cloud Native Compiler, you may want to install a separate instance of Prometheus and Grafana to just monitor your test instance of Cloud Native Compiler. The cnc-install.zip file contains monitoring manifests for setting up a fresh instance of Prometheus and Grafana.

Installing Prometheus and Grafana

Note
 The monitoring manifests use the nodeSelector to install Prometheus and Grafana on an infrastructure node. If you are deploying to a single-node setup like minikube, comment out the nodeSelector section. The manifest also requires you to create a persistent volume of at least 1GB.

  1. Deploy prometheus and node-exporter.

     
    $ kubectl apply -f cnc-monitoring.yaml

    + The manifest automatically creates a lens-metrics namespace and deploys the components there.

  2. Deploy grafana.

     
    $ kubectl apply -f grafana.yaml -n lens-metrics

  3. Find the IP address of any node in the cluster.

     
    $ kubectl describe pods grafana -n lens-metrics | grep Node:

  4. Access the Grafana UI in a web browser:app-name:

  5. Add the data source to the Grafana dashboard. Choose Configuration > Data Sources > Add data source > Prometheus > Select. In Section URL add http://<NODE_IP_ADDRESS>:30900. Click the Save and Test button.

  6. Proceed to adding the Grafana dashboard as shown below.

Installing the Grafana Dashboard

<cnc-install-dir/grafana/cnc_dashabord.json is a Grafana configuration file for a dashboard of key Cloud Native Compiler metrics. You can import the dashbaord into your existing Grafana installation.

Once you have imported and opened the dashboard, select the data source you configured above in the Data Source drop-down.

Retrieving Cloud Native Compiler Logs

All Cloud Native Compiler components, including third-party ones, log some information to stdout. These logs are very important for diagnosing problems.

You can extract individual logs with the following command:

 
$ kubectl -n <my-namespace> logs <pod>

However by default Kubernetes keeps only the last 10 MB of logs for every container, which means that in a cluster under load the important diagnostic information can be quickly overwritten by subsequent logs.

You should configure log aggregation from all CNC components, so that logs are moved to some persistent storage and then extracted when some issue needs to be analyzed. You can use any log aggregation One suggested way is to use Loki. You can query the Loki logs using the logcli tool.

Here are some common commands you can run to retrieve logs:

  • Find out host and port where Loki is listening

     
    $ export LOKI_ADDR=http://<ip-adress>:<port>

  • Get logs of all pods in the selected namespace

     
    $ logcli query --since 24h --forward --limit=10000 '{namespace="zvm-dev-3606"}'

  • Get logs of a single application in the selected namespace

     
    $ logcli query --since 24h --forward --limit=10000 '{namespace="zvm-dev-3606" app="compile-broker"}'

  • Get logs of a single pod in the selected namespace

     
    $ logcli query --since 24h --forward --limit=10000 '{namespace="zvm-dev-3606",pod="compile-broker-5fd956f44f-d5hb2"}'

Extracting Compilation Artifacts

Cloud Native Compiler stores a record of every compilation request and its processing result in a Compilation Index. Also it stores logs of compiler engine executions. By default these logs only include information about failed compilations.

You can retrieve information from the Compilation Index using a special REST endpoint on the gateway:

  • /testing/compilations — returns JSON containing all compilations performed in the life of the serer

  • /testing/compilations?vmid=<VM_ID> — Returns the compilation history for a single VM identified by VM_ID ??? Ho do I get the VM_ID?

  • /testing/diagnostic-dump — returns a ZIP archive containing both compilation metadata and compiler engine logs (including crashdumps and coredumps if present) for all compilations that the service ever performed

  • /testing/diagnostic-dump?vmid=<VM_ID> — the same as above, but only for a single VM identified by VM_ID

It is recommended to only query these endpoints using the vmid=<VM_ID> parameter, as returning information for the entire history of the service can lead your Cloud Native Compiler service performance to degrade.