This topic lists the parameters that are used to collect and send data with Tanzu Telemetry Collector.

Note: If you have an HTTP proxy server on your network you must set https_proxy with the hostname or IP address of the proxy server.

Collect

To collect data with Tanzu Telemetry Collector you configure the following parameters:





Flag Environment Variable Description
output-dir $OUTPUT_DIR
  • string
  • Local directory where the command writes the output tar file
url $OPS_MANAGER_URL
  • string
  • Ops Manager URL where the command collects data from.
username $OPS_MANAGER_USERNAME
  • string
  • Ops Manager username
  • Not required if you are using client authentication
password $OPS_MANAGER_PASSWORD
  • string
  • Ops Manager password
  • Not required if you are using client authentication
client-id $OPS_MANAGER_CLIENT_ID
  • string
  • Ops Manager client ID
  • Client needs to be a member of the opsman.restricted_view group or higher
  • Not required if you are using the username and password parameters for authentication
client-secret $OPS_MANAGER_CLIENT_SECRET
  • string
  • Ops Manager client secret
  • Not required if you are using the username and password for authentication
env-type $ENV_TYPE
  • string
  • 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 $FOUNDATION_NICKNAME
  • string
  • Specify foundation nickname used in reporting by VMware
insecure-skip-tls-verify (none)
  • Skips TLS validation on HTTP requests to Ops Manager
ops-manager-timeout $OPS_MANAGER_TIMEOUT
  • integer
  • Timeout in seconds for establishing an Ops Manager connection
  • Defaults to 30 seconds
  • Optional
ops-manager-request-timeout $OPS_MANAGER_REQUEST_TIMEOUT
  • integer
  • Timeout in seconds to wait for OpsManager to fulfill a request
  • Defaults to 30 seconds
  • Optional
with-credhub-info $WITH_CREDHUB_INFO
  • Optional
  • When present, this will allow the Telemetry Collector to pull additional certificate information from Credhub so that VMware can help flag soon-to-expire certificates
  • Requires network access to the Credhub VM which is co-located on the BOSH Director VM
cf-api-url $CF_API_URL
  • string
  • Required if usage data collection is desired
  • Used to retrieve the foundation’s UAA URL, which is required to collect Usage Service data
usage-service-url $USAGE_SERVICE_URL
  • string
  • Required for usage data collection
  • Usage Service URL where the command collects usage data from
  • Example: https://app-usage.YOUR-SYSTEM-DOMAIN
usage-service-client-id $USAGE_SERVICE_CLIENT_ID
  • string
  • Usage Service client ID
  • Required for usage data collection
  • Client needs to be a member of either the cloud_controller.admin or usage_service.audit group
usage-service-client-secret $USAGE_SERVICE_CLIENT_SECRET
  • string
  • Usage Service client secret
  • Required for usage data collection
  • Client needs to be a member of either the cloud_controller.admin or usage_service.audit group
usage-service-insecure-skip-tls-verify $USAGE_SERVICE_INSECURE_SKIP_TLS_VERIFY
  • Required for usage data collection
usage-service-timeout $USAGE_SERVICE_TIMEOUT
  • integer
  • Timeout on request connection and fulfillment to Usage Service in seconds
  • Defaults to 30 seconds
  • Optional
config $CONFIG_FILE
  • Config file for all other command line arguments
  • Requires a file extension e.g. ‘.yml’ or ‘.json’

Send

To send data with Tanzu Telemetry Collector you configure the following parameters:

Flag Environment Variable Description
path (none)
  • string
  • Path to the FoundationDetails_#######.tar file written by the collect command
api-key $API_KEY
  • string
  • Key used to authenticate with the Tanzu Telemetry API
  • Provided to customers by VMware

check-circle-line exclamation-circle-line close-line
Scroll to top icon