How to add an APM Insight Java agent in Kubernetes via InitContainers?

How to add an APM Insight Java agent in Kubernetes via InitContainers?

Step 1. 
Create a secret to access the APM Insight license key in your application namespace:
kubectl create secret generic app-secret --from-literal=s247licensekey='your_APMInsight_license_key' -n petclinic
  1. The license key can be obtained from the APM tab in Applications Manager. 
  2. Replace 'app-secret', 'your_APMInsight_license_key', and 'petclinic' (namespace) with the appropriate values.      

Step 2. 
To create an empty volume for copying and storing the agent files during the InitContainers process, execute the following command:
volumes:
   - name: APMagent

Step 3. 
Include the following InitContainers command in your helm chart/deployment YAML file:
  1. initContainers:
  2.       - name: agent-copy
  3.         image: site24x7/apminsight-javaagent:latest
  4.         imagePullPolicy: IfNotPresent
  5.         command: ['cp', '-r', '/opt/site24x7/.', '/home/apm']
  6.         volumeMounts:
  7.         - name: APMagent
  8.           mountPath: /home/apm

Step 4. 
Execute the following to mount the volume created in step 2 into you application container:
  1. containers:
  2.       - name: petclinic
  3.         image: petclinic:latest
  4.         imagePullPolicy: IfNotPresent
  5.         ports:
  6.         - containerPort: 8080
  7.        volumeMounts:
  8.         - name: s247agent
  9.           mountPath: /home/apm
mountPath - The path inside the container where the volume will be mounted

Step 5. 
Add the following environment variables to the application containers:

Environment variable 1
Name: S247_LICENSE_KEY 
Value: s247licensekey from the secret added in step 1
      
Environment variable 2
Name: JAVA_TOOL_OPTIONS 
Value: "-javaagent:[mount/path]/apminsight-javaagent.jar -Dapminsight.application.name=[DesiredMonitorName]"

In the following commands, we configure the arguments that the application (Java process) will use during startup and the agent to report data to the specified monitor name.
Example:
  1. env:
  2.         - name: JAVA_TOOL_OPTIONS
  3.           value: -javaagent:/home/apm/apminsight-javaagent.jar -Dapminsight.application.name=petclinic-k8s
  4.         - name: S247_LICENSE_KEY
  5.           valueFrom:
  6.             secretKeyRef:
  7.               name: petclinic-secrets
  8.               key: s247_license_key
Example for YAML deployment file:
  1. apiVersion: v1
  2. kind: Namespace
  3. metadata:
  4.   name: petclinic

  6. ---
  7. apiVersion: v1
  8. kind: Secret
  9. metadata:
  10.   name: petclinic-secrets
  11.   namespace: petclinic
  12. type: Opaque
  13. data:
  14.   s247_license_key: OGQ3NTg0YmIxNWE1YTIzYjhmN35rfed2M1M2U3N2ExOTVhNzM1YWYyMg==

  16. ---
  17. apiVersion: apps/v1
  18. kind: Deployment
  19. metadata:
  20.   namespace: petclinic
  21.   name: petclinic-deployment
  22.   labels:
  23.     app: petclinic
  24. spec:
  25.   replicas: 2
  26.   selector:
  27.     matchLabels:
  28.       app: petclinic
  29.   template:
  30.     metadata:
  31.       labels:
  32.         app: petclinic
  33.     spec:
  34.       containers:
  35.       - name: petclinic
  36.         image: petclinic:latest
  37.         imagePullPolicy: IfNotPresent
  38.         ports:
  39.         - containerPort: 8080
  40.         env:
  41.         - name: JAVA_TOOL_OPTIONS
  42.           value: -javaagent:/home/apm/apminsight-javaagent.jar -Dapminsight.application.name=petclinic-k8s
  43.         - name: S247_LICENSE_KEY
  44.           valueFrom:
  45.             secretKeyRef:
  46.               name: petclinic-secrets
  47.               key: s247_license_key
  48.         volumeMounts:
  49.         - name: s247agent
  50.           mountPath: /home/apm
  51.       initContainers:
  52.       - name: agent-copy-init
  53.         image: site24x7/apminsight-javaagent:latest
  54.         imagePullPolicy: IfNotPresent
  55.         command: ['cp', '-r', '/opt/site24x7/.', '/home/apm']
  56.         volumeMounts:
  57.         - name: s247agent
  58.           mountPath: /home/apm
  59.       volumes:
  60.       - name: s247agent

  62. ---
  63. apiVersion: v1
  64. kind: Service
  65. metadata:
  66.   namespace: petclinic
  67.   name: petclinic-service
  68. spec:
  69.   type: NodePort
  70.   selector:
  71.     app: petclinic
  72.   ports:
  73.     - protocol: TCP
  74.       port: 8080
  75.       targetPort: 8080
  76.       nodePort: 30200
        New to M365 Manager Plus?
        New to M365 Manager Plus?
          New to RecoveryManager Plus?
          New to RecoveryManager Plus?
            New to Exchange Reporter Plus?
            New to Exchange Reporter Plus?
              New to SharePoint Manager Plus?
              New to SharePoint Manager Plus?
                  See all integrations
                  New to ADManager Plus?

                    New to ADSelfService Plus?

                    Start your free trial

                      • Related Articles

                      • Adding APM Insight Java agent in a Kubernetes environment

                        There are three methods for installing the APM Insight Java agent in a Kubernetes environment. Using Dockerfile Using InitContainers Using Persistent Volumes Prerequisites Download the latest APM Insight Java agent (apminsight-javaagent.zip) file. ...

                      • Self monitor Applications Manager using APM Insight Java Agent

                        Applications Manager is built with Java, hence we can monitor it using APM Insight Java Agent to measure it's performance continuously, which can be very much useful. Setting up APM Insight Java Agent Follow the below steps to download and set up the ...

                      • APM Insight Java agent setup in K8s via Persistent Volumes

                        Prerequisites 1. A persistent volume (with a capacity of 100mb). 2. The persistent volume mounted on all deployment pods (via persistent volume claim). 3. The Applications Manager APM Insight Java agent zip file was downloaded, moved, and extracted ...

                      • Uninstrumented Block of Code - APM Insight

                        In the traces tab --> Slowest Method Calls and Count we show if you find Un-instrumented block of code the reason is as follows: Basically, What is un-instrumented block of code in APM Insight? By default, APM Insight agent monitors known frameworks ...

                      • How to rename an existing APM - Java agent application's monitor?

                        In Applications Manager's APM(Application Performance Monitoring) doesn't support renaming applications/monitors from the web client. However, the application name of an existing application instance can be renamed in the `apminsight.conf` file and ...

                        Related Products