overops/agent-sidecar repository overview

⁠OverOps Agent

OverOps analyzes your application in real-time, providing code-level insights in QA, Staging and Production. Monitor your applications, not your logs. Visit overops.com⁠ to learn more.

⁠Supported tags and respective Dockerfile links

• latest (Dockerfile)⁠
• alpine-latest (Dockerfile)⁠
• debug (Dockerfile)⁠

⁠Agent Sidecar

This image is intended to be used as a Kubernetes Sidecar. Add this image as an Init Container to your Pod along with the container you wish to monitor. Mount the /takipi shared volume in your container. When the Pod starts, the Agent will be copied from the sidecar into the shared folder.

Before using this image, you must have a Collector⁠ deployed in your environment.

1. Add the Sidecar as an Init Container, following this this example manifest⁠.

   apiVersion: v1
   kind: Pod
   metadata:
     name: example-sidecar-pod
   spec:
     volumes:
     - name: overops-agent
       emptyDir: {}
     initContainers:
       - name: overops-agent
         securityContext:
           runAsUser: 1000
           runAsGroup: 1000
           fsGroup: 1000 
         image: overops/agent-sidecar:latest
         imagePullPolicy: Always
         volumeMounts:
         - name: overops-agent
           mountPath: /takipi
     containers:
         #
         # add your container here
         #
         env:
         - name: TAKIPI_COLLECTOR_HOST
          # example only - set to your collector hostname
           value: "overops-collector-service"
         - name: TAKIPI_COLLECTOR_PORT
           value: "6060"
         - name: JAVA_TOOL_OPTIONS
           # example only - update application.name and deployment.name for your app
           value: "-agentpath:/takipi/lib/libTakipiAgent.so=takipi.application.name=<your app name>,takipi.deployment.name=<your app version>"
         volumeMounts:
         - name: overops-agent
           mountPath: /takipi
   

   Copy

2. Update environment variables.

   1. Set TAKIPI_COLLECTOR_HOST to your Collector hostname.
   2. Set JAVA_TOOL_OPTIONS to -agentpath:/takipi/lib/libTakipiAgent.so
   3. Optionally, you may also set application name and deployment name with JAVA_TOOL_OPTIONS like this: -agentpath:/takipi/lib/libTakipiAgent.so=takipi.application.name=<your app name>,takipi.deployment.name=<your app version>

3. Verify connectivity on https://app.overops.com/⁠ in your browser.

⚠️ Tip This container will stop running after copying the Agent into the /takipi directory. It is intended to be used only as an Init Container Sidecar in Kubernetes.

⁠Note about Security Context

Starting with version 4.56.0, all published images to Docker hub are now "rootless." Images are now using the base image openjdk:8-jre-slim and running with user ID 1000 and group ID 1000 instead of the root user. This is now reflected in the kubernetes deployment's security context.

For the agent-sidecar make sure to apply the correct security context for the init-container in order to avoid permission issues. Note that the application pod can run as a different user, as the permissions for the volume mount will allow this.