Adding APM Insight Java agent in Kubernetes via InitContainers

Step 1:
Create a secret for the Site24x7 license key in your application namespace.

You can obtain the license key from your site24x7 account by navigating to Admin > Developer > Device Key.

      Example:

1. kubectl create secret generic app-secret --from-literal=s247_license_key=<your_s247_license_key> -n petclinic
   

            Replace app-secret, <your_s247_license_key>, and namespace (petclinic) with the appropriate values.

Step 2:
Create an empty volume that will be used to copy the agent files during the InitContainers process.

      Example:

1. volumes:
2.    - name: s247agent
   

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: s247agent
8.           mountPath: /home/apm

Step 4:
Mount the volume created in step 2 into your application container.

      
      Example:

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
   

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

      
      Environment variable 1:

      Name: S247_LICENSE_KEY 

      Value: s247_license_key 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 this step, 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 YAML deployment file for your reference:

1. apiVersion: v1
2. kind: Namespace
3. metadata:
4.   name: petclinic
5. 
   
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==
15. 
    
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
61. 
    
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

• Related Articles

• How to identify and resolve conflicts between other APM products and the APM Insight .NET agent

  Problem statement: You are experiencing either of the below issues and suspect that another APM product is interfering with the Site24x7 .NET agent. 1. The .NET monitor is not created under APM > APM Insight > Applications, even after the .NET agent ...

• APM Insight integration for Next.js in Kubernetes

  To integrate the Site24x7 APM Insight Next.js agent into your Kubernetes application using initContainers with the prebuilt agent image, follow the steps below: Prerequisites A Next.js application container image The Site24x7 APM Insight license key ...

• Bundled .NET and .NET Core agents in a single MSI

  In APM Insight .NET agent version 6.8.0, the .NET and .NET Core agents have been bundled into a single MSI, enabling unified monitoring of both application types. Upgrade requirements for .NET Core agent 6.7 and below If you're using .NET Core agent ...

• Unable to add SQL insight monitor

  If the SQL Insight monitor is not getting added even after entering your credentials, try these troubleshooting steps: Ensure that the Auto-discover applications feature is enabled. If not, you will need to trigger discovery using the Discover ...

• How to uninstall the Site24x7 Windows Server Monitoring Agent

  Method 1: To uninstall the Site24x7 Windows Server Monitoring Agent, click the link below: https://staticdownloads.site24x7.com/server/Site24x7WindowsAgentUninstall.zip Unzip and execute the Uninstall.bat file in the Command Prompt as an ...