Use the helper script to monitor applications and operating systems on a Linux platform using open source Telegraf.

The helper script is tested only on the following operating systems:
  • CentOS 7.x and CentOS 8.x
  • RHEL 7.x and RHEL 8.x
  • SUSE 12.x and SUSE 15.x
  • OEL7.x and OEL 8.x
  • Ubuntu 16.x, Ubuntu 18.x, Ubuntu 20.x, and Ubuntu 22.x
  • VMware Photon Linux

Prerequisites

  • Install the jq package. For more information, see the official documentation for jq from https://stedolan.github.io/jq/download/.
  • Ensure that VMTools version >=10.2 if a vCenter Server VM is monitored by VMware Aria Operations. vmware-toolbox-cmd is necessary only for vCenter Server VMs.
  • Ensure that you have permissions to run the following commands and use the following packages:
    • Commands: /bin/bash, awk, sed, vmware-toolbox-cmd, jq, curl
    • Packages: coreutils (chmod, chown, cat), net-tools (ip, /dev/tcp, curl, wget)
  • Only IPv4 is supported at present for cloud proxy.
  • Ensure that cloud proxy is up and online in VMware Aria Operations. In the case of collector groups, ensure that at least one cloud proxy in the application monitoring high availability activated collector group is up and online in VMware Aria Operations.
  • Verify that unzip is at 6.0-20.el7 or above.
  • The uuidgen package must exist on the endpoint VM/physical server.
  • The endpoint VM/physical server must have access to port 8443 and 443 of cloud proxy or the virtual IP of the application monitoring high availability activated collector group.

Procedure

  1. Download the helper script from cloud proxy located at https://<CloudProxy-IP>/downloads/salt/telegraf-utils.sh.
    Note: Use the relevant cloud proxy IP address for <CloudProxy-IP> in the preceding commands and location specified. For application monitoring high availability activated collector groups, provide the virtual IP.
  2. Navigate to the directory where the script is downloaded.
  3. Activate execution permission of the script for Linux VM. 
    chmod +x telegraf-utils.sh
  4. Run the helper script to update Telegraf configurations. 
    telegraf-utils.sh  opensource -c cloud_proxy_ip_or_collector_group_name -t token -d telegraf_conf_dir -e telegraf_bin_path -v vmwareariaoperations_ip_or_fqdn
    
Description of arguments:
      -c : [REQUIRED] cloud_proxy_ip_or_collector_group_name - Cloud Proxy IP or Collector Group Name
      
       -t : [REQUIRED] token - Auth Token of the user/account. For getting a new token:
          (https://<VMwareAriaOperations_IP>/suite-api/ or curl -ks -X POST https://<VMwareAriaOperations_IP>/suite-api/api/auth/token/acquire -H \"Content-Type: application/json\" -H \"Accept: application/json\" -d \"{\"username\":\"<VMwareAriaOperations_USER>\",\"password\":\"<VMwareAriaOperations_USER_PASSWORD>\"}\")
      -d : [REQUIRED] telegraf_conf_dir - Telegraf configuration directory and it is required argument. ex: /etc/telegraf/telegraf.d
      -e : [REQUIRED] telegraf_bin_path - Path of telegraf executable ex: /usr/bin/telegraf
      -v : [REQUIRED] vmwareariaoperations_ip_or_fqdn - IP/FQDN of VMware Aria Operations master node and required for on-prem.
      

Example: /bin/bash telegraf-utils.sh opensource -t gi7lwabjnvdfiawt4watzksuol8sywrjvg8kabh31mx9x1guepgyhycyx61dqrpq -v 10.10.10.100 -c 10.10.10.101 -d /etc/telegraf/telegraf.d -e /usr/bin/telegraf
    Note: After you run the helper script, ensure that the respective configurations are set correctly in the given config directory ( -d option) path with the name cloudproxy-http.conf. See Sample Configurations for more details. For managed vCenter Server VMs you might see unmanaged configurations, because of one of the following reasons:
    • vCenter Server VM details are not available in VMware Aria Operations by the vCenter Server adapter. Wait for a minimum of one to two collection cycles after configuring the VMware Aria Operations vCenter Server cloud accounts.
    • An incorrect AUTHENTIFICATION_TOKEN or vROps_IP.
    Note: By default, the InfluxDB output plugin is active in the telegraf.conf file and data is sent to the influxdb server so that you do not get multiple warning messages in the logs about the lack of configured influxdb server comment, the "[[outputs.influxdb]]" line should be commented. The following warning message is displayed: W! [outputs.influxdb] When writing to [http://localhost:8086]: database "telegraf" creation failed: Post "http://localhost:8086/query": dial tcp [::1]:8086: connect: connection refused

    Example: #[[outputs.influxdb]]

    Note: Ensure that the input plugins in the telegraf.conf file are related to the corresponding operating system. See Telegraf Configuration Details for Operating Systems.
  5. Restart the Telegraf service. 
    systemctl restart telegraf 
or
/usr/bin/telegraf -config /etc/telegraf/telegraf.conf -config-directory /etc/telegraf/telegraf.d

What to do next

Managed VM object hierarchy:
  • If a vCenter Server VM is monitored by VMware Aria Operations , then the operating system and application objects fall under the respective VM > OS object > 'application service' instance.

Unmanaged VM object hierarchy: If a vCenter Server VM is not monitored by VMware Aria Operations , then the operating system and application objects fall under Environment > Operating System World > OS object > 'application service' instance.