Java Remote Debug for Applications Running in Kubernetes

Kubernetes 1.2 was just released and is quickly becoming the defacto cluster management solution for containers (Docker, Rocket, Hyper, etc). Check it out if you haven’t already – here are some interesting tidbits about the 1.2 release:

• Cluster can now scale to 30,000 containers per cluster
• Graceful shutdown of nodes, transitioning to other running nodes in the cluster
• Custom defined metrics as the basis for autoscaling
• Dynamic configuration management

When you’re developing microservices on your local laptop, you can use something like Kubernetes to run you docker containers locally and get developer/QA/production likeness in how you deploy your applications. For example, you get process isolation, port-space isolation, network/storage, etc so things don’t collide on your local developer laptop.

One thing for Java Developers that comes up is how do you view logs, do remote debug, and take stack traces.

Here are a few tips:

Tailing Logs for Your Pod

On some cluster management systems, you have to basically look up the local IP of your application (if running in a container), ssh into it somehow, and then find the log and tail it. With Kubernetes, you don’t have to do any of that. Regardless of which machine you’re running on (ie, where you run the kubernetes client), you can do the following:

List the pods in your cluster

ceposta@postamac(~) $ kubectl get pod
NAME                        READY     STATUS    RESTARTS   AGE
broker-amq-1-hjbeh          1/1       Running   1          15h
file-ingress-events-3artj   1/1       Running   1          13h

Tail the logs

Now pick the pod you want to stream the logs from and go!

ceposta@postamac(~) $ kubectl logs -f file-ingress-events-3artj

Connect via Shell if you must

If you must log into the pod for some reason (poke around the file system, grok other config files, etc):

ceposta@postamac(~) $ kubectl exec -it file-ingress-events-3artj bash

JVM Remote Debug Your Application

This becomes really handy to see exactly what’s going on in your application. To do this, you don’t really do anything different from what you do today. When you bootstrap your JVM, you should have a way to enable JVM debug. For example, for the HawtApp Maven plugin which is a simple mvn plugin that assigns a Java Main as the executable and a simple, flexible bootstrap bin/run.sh script (or batch file for windows) that allows you to control classpath and debugging via environment variables.

Bootstrap Java app to be able to expose remote debug port

Example:

# Set debug options if required
if [ x"${JAVA_ENABLE_DEBUG}" != x ] && [ "${JAVA_ENABLE_DEBUG}" != "false" ]; then
    java_debug_args="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=${JAVA_DEBUG_PORT:-5005}"
fi

Define debug port in docker container via kubernetes manifest

Now you need to expose port 5005 (in this example) in your Docker containers via your Kubernetes manifest (json/yaml) file:

    spec:
        containers:
        - args: []
          command: []
          env:
          - name: "JAVA_ENABLE_DEBUG"
            value: "true"
          - name: "OUTGOING_FILE_PATH"
            value: "/deployments/camel/outgoing"
          - name: "INCOMING_FILE_PATH"
            value: "/deployments/camel/incoming"
          - name: "KUBERNETES_NAMESPACE"
            valueFrom:
              fieldRef:
                fieldPath: "metadata.namespace"
          image: "fabric8/file-ingress-events:1.0-SNAPSHOT"
          name: "file-ingress-events"
          ports:
          - containerPort: 5005
            name: "jvm-debug"
          - containerPort: 8778
            name: "jolokia"

Note, we’ve also added an env variable in the kubernetes manifest file to be able to control whether we want remote debugging on or off (true/false). The bootstrap scripts (above) will check that env variable and you can control it via the kube manifest (now with ConfigMap in Kube 1.2, or OpenShift templates).

The last step is to proxy the debug port to your local machine. If you run the kubectl client locally, this is easy:

List the pods in your cluster

ceposta@postamac(~) $ kubectl get pod
NAME                        READY     STATUS    RESTARTS   AGE
broker-amq-1-hjbeh          1/1       Running   1          15h
file-ingress-events-3artj   1/1       Running   1          13h

Proxy the pod to a specific port

ceposta@postamac(~) $ kubectl port-forward file-ingress-events-3artj  5005:5005

The above will port-forward from your local environment (5005) to the pod’s port 5005. Now you can just attach your remote debugger to localhost:5005.

Hope this helps you debug your Java apps!