Using the Tanzu Telemetry Collector CLI

This topic explains how to use the Tanzu Telemetry Collector Command-Line Interface (CLI).

Note VMware recommends installing the Tanzu Telemetry Collector with Concourse. For more information, see Using Tanzu Telemetry Collector with Concourse.

Prerequisite

To complete the steps in this section, you must have the Tanzu Telemetry Collector CLI binary that corresponds to your operating system. You can download the binary from Tanzu Network.

Install Manually

To install the Tanzu Telemetry Collector manually, complete the following steps:

1. Add the binary to your $PATH.
2. Open a terminal window and enter telemetry-collector to verify your installation. If your installation succeeds, the command returns help commands.

Using Tanzu Telemetry Collector CLI

Once you have installed the CLI, follow the procedure below to collect data from your PCF foundation and send it to VMware.

Collect

To collect data from your TAS for VMs foundations Operations Manager (and optionally Usage Service), use one of the following commands with information from your foundation:

Collect All Data (Recommended)

telemetry-collector collect --url --username --password [or --client-id and
--client-secret] --usage-service-url --usage-service-client-id
--usage-service-client-secret --cf-api-url --env-type --output-dir --foundation-nickname

Collect Only Operational Data

telemetry-collector collect --url --username --password [or --client-id and
--client-secret] --usage-service-url --usage-service-client-id
--usage-service-client-secret --cf-api-url --env-type --output-dir --foundation-nickname
--operational-data-only

Collect Only Configuration Data

telemetry-collector collect --url --username --password [or --client-id and
--client-secret] --env-type --output-dir --foundation-nickname

Where:

• --url is the Operations Manager URL where the command collects data from.
• --username is your Operations Manager username.
• --password is your Operations Manager password.
• --client-id needs to be created within the OM UAA for accessing OM API and needs to be a member of opsman.restricted_view or higher.
• --client-secret is the secret associated with the client-id.
• --env-type is the type of environment you are using to collect data. You can enter one the following options:
  • sandbox
  • development
  • qa
  • pre-production
  • production
• --foundation-nickname is an optional field that specifies a foundation nickname to be used in reporting by VMware
• --cf-api-url is the CF API URL for UAA authentication to access Usage Service
• --usage-service-url is the Usage Service URL (this URL is typically: https://app-usage.YOUR-SYSTEM-DOMAIN)
• --usage-service-client-id is the Usage Service client id. Note that this client needs to exist in the PAS UAA and to be a member of either the cloud_controller.admin or usage_service.audit group.
• --usage-service-client-secret is the Usage Service client secret.
• --output-dir is your local directory where the command writes the output tar file.
• --operational-data-only is an optional flag that, when set, only collects Operational Data (ie. Usage Service and Core Consumption data)

Note Your Operations Manager username and password are not required if you are using client authentication. For more information on the available flags, see Configuration Reference.

Note If you want to configure the Telemetry Collector to send Usage Service data, you must include information for all four flags related to the Usage Service.

If the command succeeds, it returns the following message:

 Wrote output to MY-FILE-PATH/FoundationDetails_#######.tar Success!

After running the command, you can examine the data collected in the FoundationDetails_######.tar file.

Send

The FoundationDetails_######.tar file can be copied to another machine if necessary. To send data to VMware from your PCF foundation, run the following command:

telemetry-collector send --path --api-key

Where:

• --path is the path to the FoundationDetails_######.tar file written by the collect command.
• --api-key is the Telemetry API key used to authenticate with VMware.

Note You must send the original, unmodified FoundationDetails.tar file for the command to work.

If the command succeeds, it returns the following message:

 Success!