APM Insight integration for Next.js in Kubernetes

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 

  1. A Next.js application container image
  2. The Site24x7 APM Insight license key
  3. The application name and application port details

Integration steps 

Step 1: Create an empty volume 

Create and define an empty volume that will be used to copy the agent files during the initContainers process:
  1. volumes:
  2. - name: agent-volume
  3. emptyDir: {}

Step 2: Add initContainers to copy agent files 

To configure your deployment, add the following initContainers specification to your Helm chart or deployment YAML file:
  1. initContainers:
  2. - name: init-apm
  3. image: site24x7/apminsight-nextjsagent:1.2.0
  4. imagePullPolicy: Always
  5. command: ['cp', '-r', '/opt/site24x7/.', '/apm']
  6. volumeMounts:
  7. - name: agent-volume
  8. mountPath: /apm

Step 3: Mount the volume in the application container

Mount the volume created in step 2 into your application container.
Example
  1. containers:
  2. env:
  3. - name: NODE_OPTIONS
  4. value: "--require /apm/node_modules/@apminsight/next"
  5. - name: APMINSIGHT_LICENSE_KEY
  6. value: "xxxxxxxxxxxxxxxx"
  7. - name: APMINSIGHT_APP_NAME
  8. value: "k8s-nextjs-application"
  9. - name: APMINSIGHT_APP_PORT
  10. value: "3001"
  11. volumeMounts:
  12. - name: agent-volume
  13. mountPath: /apm

NotesFor applications using the PM2 process manager instead of Kubernetes, enable PM2 support by adding the following in the env section of your deployment YAML file:
  1. - name: APMINSIGHT_PROCESS_MANAGER
  2.   value: "true"

Example 

Here's a sample YAML deployment file:
  1. apiVersion: apps/v1
  2. kind: Deployment
  3. metadata:
  4. name: nextjs-app
  5. namespace: nextjs
  6. labels:
  7. app: nextjs-app
  8. version: v1
  9. spec:
  10. replicas: 1
  11. selector:
  12. matchLabels:
  13. app: nextjs-app
  14. template:
  15. metadata:
  16. labels:
  17. app: nextjs-app
  18. version: v1
  19. spec:
  20.  initContainers:
  21.  - name: init-apm
  22. image: site24x7/apminsight-nextjsagent:1.2.0
  23. imagePullPolicy: Always
  24. command: ['cp', '-r', '/opt/site24x7/.', '/apm']
  25. volumeMounts:
  26. - name: agent-volume
  27. mountPath: /apm
  28. containers:
  29. - name: nextjs-app
  30. image: nextjs-sampleapp:latest
  31. ports:
  32. - containerPort: 3001
  33. name: http
  34. env:
  35. - name: NODE_OPTIONS
  36. value: "--require /apm/node_modules/@apminsight/next"
  37. - name: APMINSIGHT_LICENSE_KEY
  38. value: "xxxxxxxxxxxxxxxx"
  39. - name: APMINSIGHT_APP_NAME
  40. value: "k8s-nextjs-application"
  41. - name: APMINSIGHT_APP_PORT
  42. value: "3001"
  43. imagePullPolicy: Always
  44.  volumeMounts:
  45. - name: agent-volume
  46. mountPath: /apm
  47. volumes:
  48. - name: agent-volume
  49. emptyDir: {}
  50. restartPolicy: Always

    • 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 ...

    • Site24x7 to ServiceNow CMDB integration: CI mapping reference

      Site24x7 provides integration with ServiceNow, allowing seamless population of Configuration Items (CIs) in your ServiceNow CMDB based on your monitored resources in Site24x7. This article provides a reference for the field mappings used during the ...

    • How can I choose resources in a monitor group for third-party integration

      By associating the monitor group with a tag, you can select the resources in a monitor group for third-party integration. Read how to add a tag to a monitor group.    Once you have added a tag to the group, choose the tag to integrate the resources ...

    • 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 integrate Site24x7 with an LLM

      You can integrate LLMs with Site24x7 monitors to derive an overall summary of your monitors. The Zia Bot can answer all your queries regarding the monitors to which you have access and answer basic questions about all monitors. The Zia Bot uses the ...