Monitoring Applications using Open Source Telegraf on a Windows Platform

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

The helper script is tested only on Windows Server 2012, 2012 R2, 2016, 2019, and 2022.

Prerequisites

Verify that Windows PowerShell is at 4.0 or above.
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.
Only IPv4 is supported at present for cloud proxy.
Ensure that Internet is enabled.
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.
vCenter Server VMs, AWS EC2 instances, Azure VMs, or the 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

Download the helper script from cloud proxy located at https://<CloudProxy-IP>/downloads/salt/telegraf-utils.ps1.

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.

If the script download fails with the following message: The request was aborted: Could not create SSL/TLS secure channel, follow the steps mentioned in Script Download Fails on a Windows Platform.
Navigate to the directory where the script is downloaded.
Run the helper script to update Telegraf configurations.
```
telegraf-utils.ps1  opensource -c cloud_proxy_ip_or_collector_group_name -t token -d telegraf_conf_dir -e telegraf_bin_path [-g gateway_url -a csp_auth_url]
    
Description of arguments:
      -c : [REQUIRED] cloud_proxy_ip_or_collector_group_name - Cloud Proxy IP or Collector Group Name
      -t : [REQUIRED] token - [REQUIRED] - CSP Refresh Token of the user/account. For getting a new token, follow - 
           User/Organization Settings >> My Account >> API Tokens >> Generate a New API Token.
           Example: gi7lwabjnvdfiawt4watzksuol8sywrjvg8kabh31mx9x1guepgyhycyx61dqrpq
      
      -d : [REQUIRED] telegraf_conf_dir - Telegraf configuration directory and it is required argument. ex: C:\Telegraf\telegraf-1.20.4\telegraf.d
      -e : [REQUIRED] telegraf_bin_path - Path of telegraf executable ex: C:\Telegraf\telegraf-1.20.4\telegraf.exe
      
      -g : [OPTIONAL] [SAAS-SPECIFIC] gateway_url - argument to override default VMware Aria Operations SaaS gateway URL
      -a : [OPTIONAL] [SAAS-SPECIFIC] csp_auth_url - argument to override default CSP authentication URL


Example: .\telegraf-utils.ps1 opensource -c 10.10.10.101 -t gi7lwabjnvdfiawt4watzksuol8sywrjvg8kabh31mx9x1guepgyhycyx61dqrpq -d C:\Telegraf\telegraf-1.20.4\telegraf.d -e C:\Telegraf\telegraf-1.20.4\telegraf.exe
```
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, AWS EC2 instances, or Azure VMs, you might see unmanaged configurations, because of one of the following reasons:
- vCenter Server VMs, AWS EC2 instances, or Azure VMs details are not available in VMware Aria Operations by the vCenter Server, AWS, or Azure adapters correspondingly. Wait for a minimum of one to two collection cycles after configuring the VMware Aria Operations vCenter Server cloud accounts.
- An incorrect SAAS_REFRESH_TOKEN.
Note:
- Do not use a space in the configuration path. Paths with spaces can be passed as a short name notation, such as c:\PROGRA~1 for c:\Program Files.
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.

Note: The default gateway URL is https://www.mgmt.cloud.vmware.com/vrops-cloud and the default authentication URL is https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize. If the authentication URL and gateway URL are different from the default settings, provide the appropriate arguments (-g and -a).

Restart the Telegraf service.

telegraf.exe --config telegraf.conf --config-directory telegraf.d

Or you can make Telegraf a Windows service.

<Telegraf_executable_path> --config <Telegraf_config_file_path> --config-directory <Telegraf_config_directory_path> --service install net start telegraf

For example:

& 'C:\Telegraf\telegraf-1.20.4\telegraf.exe'  --config 'C:\Telegraf\telegraf-1.20.4\telegraf.conf' --config-directory 'C:\Telegraf\telegraf-1.20.4\telegraf.d'  --service install
net start telegraf

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 will fall under the respective VM > OS object > 'application service' instance
If an Azure VM is monitored by VMware Aria Operations, then the operating system and application objects will fall under the respective Azure VM > OS object > 'application service' instance.
If an AWS EC2 instance of the VM is monitored by VMware Aria Operations, then the operating system and application objects will fall under the respective AWS EC2 instance > OS object > 'application service' instance

Machines not monitored by VMware Aria Operations: If a vCenter Server VM, an AWS EC2 instance, an Azure VM, or a physical server is not monitored by VMware Aria Operations, then the operating system and application objects will fall under Environment > Endpoint > OS Object > 'application service' instance.

View Data Collected: Data is collected and appears in the Manage Telegraf Agents page. To view the details, you can filter by Agent Type > Open source agent from the Manage Telegraf Agents page.