This document details the Cavisson observability agent installation process in CloudFoundry platform to monitor its components and applications deployed in Tanzu Application Service. VMware Tanzu Application Service is an app development and deployment platform for public and private clouds. The observability agents provide metrics across the infrastructure and application components.

Installation Steps 

Machine Agent Installation using BOSH release 

1.  Login to a VM which has BOSH CLI available and download the latest version of machine agent release . You can contact Cavisson sales to get the latest version.

wget https://nde.cav-test.com/HUB/CavMachineAgent-4.x.x.x.tar.gz –no-check-certificate

2.Untar the package downloaded in step1. 

tar -xvzf CavMachineAgent-4.x.x.x.tar.gz

3. Go to the directory CavMachineAgent extracted after untar. 

4. Clone the java release for BOSH Packages from the official bosh git repository. 

git clone https://github.com/bosh-packages/java-release

Upon successful completion of the clone command, a new directory with the name ‘java-release’ will be created in the CavMachine agent directory. .

5. Vendor package the java-release package to Cavisson machine This creates a local blobstore in /opt that contains the vendored package .

bosh vendor-package openjdk-8 java-release

6. Create bosh release for Cavisson machine agent

bosh create-release –sha2 –tarball=CavMachineAgent-4.x.x.x.tgz –version=4.x.x — name=CavMachineAgent

7. Upload the BOSH release to the BOSH

bosh upload-release CavMachineAgent-4.x.x.x.tgz

8. Modify machine agent manifest file (located in the CavMachineAgent directory) to add the controller details and stemcell version.

— 

name: CavMachineAgent

version: 4.13.0.46

—–

name: CavMachineAgent version: 4.13.0.46 releases:

• name: CavMachineAgent version: 4.13.0.46

stemcells:

• alias: bosh-google-kvm-ubuntu-xenial-go_agent os: ubuntu-xenial

version: “621.176”
instance_groups:

• name: cmon azs:
  • asia-south1-c instances: 1 jobs:
  • name: cmon version: 13.0.46

release: CavMachineAgent properties:

       cav_controller: nspoc2.cav-test.com:6666

       cav_tier: Tanzu vm_type: micro

stemcell: bosh-google-kvm-ubuntu-xenial-go_agent networks:

• name: pas addons: [] update:

canaries: 1

max_in_flight: 1

canary_watch_time: 1000-60000

update_watch_time: 1000-60000

Sample Controller parameters:- 

9. Deploy release using updated manifest

bosh -n -d CavMachineAgent deploy manifest.yml

10. Add same controller details in yml as mentioned in manifest.yml

addons:

• name: CavMachineAgentAddon jobs:

– name: cmon

release: CavMachineAgent properties:
cav_controller: nspoc2.cav-test.com:6666cav_tier: Tanzu
include: stemcell:

– os: ubuntu-xenial releases:

• name: CavMachineAgent version: 4.13.0.46

11. Update the BOSH director runtime configuration .This runtime configuration applies to all new BOSH deployments going forward.

bosh update-runtime-config runtime.yml

12.

1. Deploy your

Since existing BOSH deployments won’t be automatically updated with the jobs specified in the runtime configuration, you need to redeploy them so that BOSH rolls out the Cavisson agent

Note:-Replace <cf-name> with your cf deployment name and <deployment yml path> with path of your cf deployment yml.

bosh -d <cf-name> deploy <deployment yml path>  

Application Agent Installation using Sidecar 

1. Login to a VM which has cf CLI available and download the latest version of application agent sidecar . You can contact Cavisson sales to get the latest version.

wget https://nde.cav-test.com/HUB/cavisson-agent-sidecar_4xx.zip –no-check-certificate

2. Create cavisson agent build pack 

cf create-buildpack cavisson-agent-sidecar-buildpack cavisson-agent-sidecar_4xx.zip 1

3. Validate if buildpacks got successfully created  

cf buildpacks |grep cavisson-agent-sidecar-buildpack

 4. Modify your application manifest.yml to include cavisson buildpack created in step2 and add controller

The below snippet shows a sample configuration for an application called shopapp

applications: 

  – name: shopapp 

    application: shopapp.war 

    disk_quota: 2G 

    instances: 2 

    memory: 1G 

    buildpacks: 

    – cavisson-agent-sidecar-buildpack 

    – java_buildpack_offline 

    env: 

      JBP_CONFIG_OPEN_JDK_JRE: ‘{ jre: { version: 11.+ }, memory_calculator: { stack_threads: 30 } }’ 

      JAVA_OPTS: ‘-XX:MaxDirectMemorySize=100M -javaagent:/home/vcap/deps/netdiagnostics/lib/ndmain.jar=time,ndAgentJar=/home/vcap/deps/netdiagnostics/lib/ndagent-with-dep.jar,ndHome=/home/vcap/deps/netdiagnostics’ 

      CAV_APP_AGENT_TIER: ShopApp 

      CAV_APP_AGENT_NDCHOST: nspoc2.cav-test.com 

      CAV_APP_AGENT_NDCPORT: 6666 

      CAV_APP_AGENT_NDC_COMM_PROTOCOL: WSS 

      CAV_APP_AGENT_SERVER: server1 

      CAV_APP_AGENT_INSTANCE: instance 

Parameters 

5. Redeploy the application to get it effective. 

Uninstallation Steps 

1. To uninstall the machine agent,  delete the release from your BOSH 

bosh delete-release <Release Name> 

 2. To uninstall the Application agent , delete the buildpack 

cf delete-buildpack cavisson-agent-sidecar-buildpack 

Monitoring 

Once you’ve completed the agent Installation you can able to see all listed metrics in Appendix section with in pre-bundled dashboard.

The dashboard provides deep level insights and facilitates a deeper understanding of trends and patterns which includes

Appendix 

Application Metrics Group

For details on stem cells refer to https://bosh.cloudfoundry.org/stemcells/