233-instrument-java-app-with-apm-agentless-on-gke

233-instrument-java-app-with-apm-agentless-on-gke

In this cookbook a Java web app (Spring PetClinic) is containerized with the APM agentless for Java (the APM Java agent library for Linux), and deployed along with a PostgreSQL database on the Linux node pool of a Google Kubernetes Engine.

With this setup, the pods and nodes of the Kubernetes cluster can scaleout, the APM will collect every transaction.

Prerequisites

1. a SaaS account for APM

2. a project in Google Cloud configured for billing and having Kubernetes setup (Linux node pool and Artifact registry)

3. Click on the button to open the cookbook in the Google Cloud Shell

Step 1. Get APM details in APM

In the APM webconsole, navigate to CONFIGURE > AGENTS > Install Agents and in the Agent Installation Steps section,

1. Find your Customer Id, for example 12341234-12341234-13241234
2. Find the SaaS Analysis Server Host and obtain the SaaS Psockets Server host replacing agents by psockets. For example if the analysis server host is agents.apm.my_environment.aternity.com then the SaaS Psockets Server host is psockets.apm.my_environment.aternity.com
3. Download the package APM Agentless Instrumentation (Java) (also available on Riverbed support, for example aternity-apm-jida-linux-12.19.0_BL516

Step 2. Prepare Google Cloud infrastructure

In the Google Cloud Console retrieve the details of the project and resources ready to use:

1. Project id, for example: aternity-cookbooks
2. Kubernetes Engine cluster name, for example: autopilot-cluster-1
3. Region, for example: europe-west9
4. Artifact Registry repository name, for example: apm
5. Bucket name, for example: my_bucket

⚠️ The repository must be created with Docker format and preferably in the same region as the GKE cluster

Step 3. Store the APM Agentless package in a Bucket Storage

In the Google Cloud Console, navigate to the Cloud Storage . then select the GCP project and the Bucket.

There, upload the .zip package of the APM Agentless Instrumentation (Java) and grab the gsutil URI for the next steps, for example gs://my_bucket/aternity-apm-jida-linux-12.19.0_BL516.zip

Step 4.Containerize the app with the APM Agentless files

1. Prepare to build

In the Cloud Shell terminal, run the commands to go to the cookbook folder, select the project (replacing {PROJECT_ID} with the actual value) and configure kubectl to control the cluster

cd 233-instrument-java-app-with-apm-agentless-on-gke
gcloud config set project {PROJECT_ID}
gcloud container clusters get-credentials {CLUSTER NAME} --region {REGION} --project {PROJECT_ID}

For example

cd 233-instrument-java-app-with-apm-agentless-on-gke
gcloud config set project aternity-cookbooks
gcloud container clusters get-credentials autopilot-cluster-1 --region europe-west9 --project aternity-cookbooks

2. Build the image

Run the command to build the image, replacing the actual values in the substitutions parameter.

gcloud builds submit --config cloudbuild.yaml --substitutions _APM_PACKAGE_GSUTIL_URI={_APM_PACKAGE_GSUTIL_URI},_REGION={_REGION},_REPOSITORY={REPOSITORY}

Where:

• {_APM_PACKAGE_GSUTIL_URI}: the gsutil URI of the APM Java library package
• {_REGION}: the region of the Artifact Registry
• {_REPOSITORY}: the name of the Artifact Registry repository

For example

gcloud builds submit --config cloudbuild.yaml --substitutions _APM_PACKAGE_GSUTIL_URI=gs://my_bucket/aternity-apm-jida-linux-12.19.0_BL516.zip,_REGION=europe-west9,_REPOSITORY=apm

Based on the Dockerfile, it is building a Docker image that will contain the Java application and the APM Java agent library for Linux. When the build is done, the image will be stored in the Artifact Registry.

Step 5. Configure the Kubernetes manifest and deploy

1. Configure the manifest

With the Cloud Shell Editor, edit the Kubernetes manifest app-k8s.yaml to configure the environment variables of your APM SaaS account and also the path of the image we just built:

• Customer Id in the variable RVBD_CUSTOMER_ID, for example 12341234-12341234-13241234
• SaaS Psockets Server host in the variable RVBD_ANALYSIS_SERVER, for example psockets.apm.my_environment.aternity.com
• Image Path in the deployment section replacing the token {cookbook-233 image}, for example: europe-west9-docker.pkg.dev/aternity-cookbooks/apm/cookbook-233:latest

2. Deploy

In the Cloud Shell Terminal, execute the following command to deploy the application on Kubernetes.

kubectl apply -f app_k8s.yaml

3. Check

After few minutes, execute the following command to get the external ip address of the load-balancer created for the app.

kubectl --namespace cookbook-233 get svc

Step 6. Navigate on the app

In your web browser, open the http url using the external IP address, for example http://external-ip-address, and navigate in the app to generate some traffic and application transactions.

Step 7. APM web console

Go to the APM webconsole to observe the application, every instance and every transaction.

Cleanup

Run the command to delete the application

kubectl delete -f app_k8s.yaml

License

Copyright (c) 2022 Riverbed

The contents provided here are licensed under the terms and conditions of the MIT License accompanying the software ("License"). The scripts are distributed "AS IS" as set forth in the License. The script also include certain third party code. All such third party code is also distributed "AS IS" and is licensed by the respective copyright holders under the applicable terms and conditions (including, without limitation, warranty and liability disclaimers) identified in the license notices accompanying the software.