Skip to main content
Version: 3.0

Configure Telemetry

Portworx Backup supports sending telemetry data to Pure1, a cloud-based management and support platform provided by Pure Storage. When telemetry is enabled, Portworx Backup automatically registers with Pure1, collects operational data, and uploads it periodically to Pure1 so that Pure Storage support teams can monitor system health and diagnose issues. For information about data handling and privacy, see the Everpure Trust Center.

note

Portworx Enterprise also supports Pure1 telemetry. For more information, see the Portworx Enterprise telemetry documentation.

note

Telemetry data is used for support, diagnostics, and service improvement only. Backup and restore data contents are never collected.

Requirements to enable telemetry​

Before enabling Pure1 telemetry, ensure that the following prerequisites are met:

  • Portworx Backup 3.0.0 or later is installed.

  • You have kubectl access to the cluster where Portworx Backup is installed.

  • The Portworx Backup cluster has outbound internet access on TCP port 443 to the following Pure1 endpoints:

    EndpointPurpose
    register.cloud-support.purestorage.comCluster registration
    rest.cloud-support.purestorage.comTelemetry data upload
    note

    Configure firewall rules using the hostnames above rather than IP addresses, as the IP addresses for these endpoints may change without notice.

How telemetry works​

Telemetry is disabled by default and must be explicitly enabled. When enabled, Portworx Backup collects system health information, performance metrics, and diagnostic logs every hour (configurable through Helm using the telemetry.logsCollector.collectionInterval parameter), then uploads this operational data to support analysis, monitoring, and troubleshooting.

During each collection cycle, Portworx Backup:

  • Collects logs from Portworx Backup components
  • Redacts sensitive information such as passwords, tokens, and keys before processing
  • Collects operational metrics and reporting information
  • Stores the collected data temporarily before upload

A dedicated persistent volume is used to store telemetry data locally prior to upload.

Telemetry Data Upload​

After collection completes, the telemetry service securely uploads the collected logs and metrics to Pure1 using mutual TLS (mTLS).

Telemetry Data Cleanup​

By default, Portworx Backup retains locally stored telemetry files for 4 hours. Files older than 4 hours are automatically deleted.

Telemetry Data in Pure1​

Uploaded telemetry data is stored in Pure1 and is used for monitoring, diagnostics, and support purposes.

note

Disabling telemetry prevents future data collection and uploads but does not remove telemetry data that has already been uploaded to Pure1.

Type of data collected by telemetry​

Portworx Backup telemetry uploads the following categories of data to Pure1:

Data typeDescription
MetricsPrometheus metrics fetched and uploaded every hour. For a full list of metrics, see Portworx Backup Metrics.
LogsSystem logs fetched and uploaded every hour

Enable telemetry​

You can enable telemetry during Portworx Backup installation or during an upgrade using helm.

For example:

Enable telemetry during installation

You can enable telemetry during installation using the set command --set telemetry.enabled=true along with other parameters.
For more information, see the Portworx Backup installation.

Enable telemetry during Helm upgrade

You can enable telemetry during upgrade using the set command --set telemetry.enabled=true and specifying the values.yaml file used during installation along with other parameters.

helm upgrade px-central portworx/px-central \
  --namespace <pxb-namespace> \
  --set telemetry.enabled=true \
  -f values.yaml

For more information, see the Portworx Backup Upgrade.

Verify telemetry status​

To verify whether telemetry is enabled, check the Helm values used for the Portworx Backup installation or upgrade.

helm get values px-central --namespace <pxb-namespace>

Proxy environments​

If your cluster routes outbound traffic through an HTTP/HTTPS proxy, configure your proxy to allow outbound connections on TCP port 443 to the following endpoints:

  • register.cloud-support.purestorage.com
  • rest.cloud-support.purestorage.com

SSL interception: Telemetry uses mutual TLS with certificates issued by Pure Storage's certificate authority. If your proxy performs SSL interception, add these endpoints to the proxy's SSL bypass list to prevent connection failures.

Authenticated proxies: If your proxy requires authentication credentials, configure the proxy secret during Portworx Backup installation. Telemetry uses the same proxy configuration defined at install time. For more information, see Proxy Support.

Refer to your proxy server documentation for instructions on configuring bypass rules and authentication.

Troubleshooting​

Pure1 endpoints are unreachable​

If telemetry is enabled but the cluster cannot reach Pure1 endpoints, Portworx Backup retries connectivity at the next scheduled interval. Uploads resume automatically when connectivity is restored.

To check if Pure1 endpoints are unreachable, run the following command:

kubectl logs -n px-backup deploy/px-backup | grep -E "OSB unreachable|Pure1 unreachable"

Telemetry pods health check​

To check the health of the telemetry pods, follow these steps:

  1. Check the telemetry pod logs:

    kubectl logs -n <pxb-namespace> -l app.kubernetes.io/name=px-backup-telemetry --tail=50

  2. Check the pod status:

    kubectl get pods -n <pxb-namespace> -l app.kubernetes.io/name=px-backup-telemetry

Next steps​

After enabling telemetry, you can manage or disable it without requiring a Helm upgrade or elevated cluster permissions. For more information, see Manage Pure1 telemetry.

Last updated on