Registration and Telemetry

Overview

Delphix Telemetry encompasses two critical functions—registering your Data Control Tower (DCT) installation to a Delphix account, then uploading analytic bundles to Delphix Compliance Services (DCS). This integration helps Delphix better understand product usage to enhance your support experience. Delphix Telemetry has an online and offline model.

Online model

  • Requires internet connectivity.

  • Registration and telemetry are simultaneously configured.

  • Automatically uploads telemetry data daily.

Offline model

  • Does not require internet connectivity.

  • Registration must be performed manually, once.

  • Bundles must be uploaded manually, typically quarterly.

You can view Delphix Telemetry service status at: status.delphix.com.

All DCT tiers (Core, Self Service, and Enterprise) support this capability. And it’s supported on all deployment types: Kubernetes, OpenShift, and Appliance.

Online registration and bundle upload

Follow these steps to register your DCT product and automatically upload Telemetry data.

  1. Complete and submit this form to request your Delphix Compliance Services (DCS) Account.

  2. Within 24-48 hours, check your email for account creation instructions and create your password.

  3. Log in to your Data Control Tower instance.

  4. Navigate to Admin > Registration.

  5. Click Register in the top right.

  6. Enter your new DCS credentials and submit.

  7. Upon successful verification, click Register DCT.

  8. Your DCT installation is now registered. Bundles are uploaded automatically every 24 hours. Confirm the last upload time in the Details section of the home DCT page.

Note: If your credentials change, repeat these steps to re-register.

Offline registration and bundle upload

Choose this method if your DCT installation lacks internet connectivity or you prefer manual uploads.

Offline registration

  1. Complete and submit this form to request your Delphix Compliance Services (DCS) Account.

  2. After 24-48 hours, use the email instructions to finalize account setup.

  3. Generate an API Token:

    1. Log in to DCS.

    2. Navigate to Accounts > API Tokens, and follow instructions to add a token. More details can be found in the Programmatic access to DCS (API Tokens) page.

    3. Save your generated API Token securely. This token will be required for each offline bundle upload.

  4. Log in to DCT.

  5. Navigate to Admin > Registration.

  6. Click Register, then select Switch to Offline Registration.

  7. Copy the provided Product ID and Public Key.

  8. In your terminal, run:

Copy 
curl --request POST \
                --url 'https://api.apps.delphix.com/v1/telemetry/register' \
                --header 'Authorization: Bearer <DCS_ACCOUNT_TOKEN>' \
                --header 'Content-Type: application/json' \
                --data '{
                "uuid": "<DCT_PRODUCT_ID>",
                "key": "<DCT_PUBLIC_KEY>"
            }'

You will receive key and token values in the response. Enter these into the respective fields in DCT.

Submit to complete offline registration. Verify successful registration status directly in the DCT UI.

Offline bundle upload

  1. Log in to DCT, navigate to Admin > Registration, and select Download Bundle.

  2. Choose a date range or leave as default for a comprehensive bundle.

  3. Clearly name your downloaded bundles with timestamps or version identifiers for easier management and historical tracking.

  4. Prepare upload location by running in your terminal:

Copy 
curl --request POST \
                --url 'https://api.apps.delphix.com/v1/telemetry/initiate' \
                --header 'Authorization: Bearer <DCS_ACCOUNT_TOKEN>' \
                --header 'Content-Type: application/json' \
            --data '{"uuid": "<DCT_PRODUCT_ID>"}'

Use the response values to execute the following command and upload your bundle. Ensure careful replacement of placeholders (e.g., <AWS_UPLOAD_URL>, <AWS_KEY>, etc.) as incorrect substitutions will cause upload errors:

Copy 
curl -X POST "<AWS_UPLOAD_URL>" \
                --form "key=<AWS_KEY>" \
                --form "x-amz-algorithm=<AWS_ALGORITHM>" \
                --form "x-amz-credential=<AWS_CREDENTIAL>" \
                --form "x-amz-date=<AWS_DATE>" \
                --form "x-amz-security-token=<AWS_SECURITY_TOKEN>" \
                --form "x-amz-signature=<AWS_SIGNATURE>" \
                --form "policy=<AWS_POLICY>" \
            --form "file=@<DCT_BUNDLE_FILE_PATH>"

A successful upload returns a 204 status which can be confirmed by using the -v verbose argument. Retain the confirmation response or take a screenshot for record-keeping and audit purposes.

Note: We request you to upload bundles periodically and as directed by your account team. To switch to the online model, simply follow the Online Registration process again.

API attribution and usage reports

DCT provides flexibility in attributing API calls by capturing optional (X-Dct-Client-Name) and mandatory (User-Agent) HTTP headers. These values are stored as client_name and user_agent, enabling detailed API usage reporting.

  • Grouping API calls: Use the group_by query parameter to group reports based on attributes like client_name, user_agent, kind, and dct_version.

  • Filtering API calls: Use query parameters (client_name, api_metric_kind) to filter reports by specific clients, API classifications, or DCT versions.

Important: Reports have a maximum limit of 10,000 records to prevent memory issues. Always limit the report scope using start_date, end_date, client_name, or user_agent parameters.

Data collection and usage

Telemetry bundles contain metadata critical to analyzing product use, improving functionality, and enhancing security. Please review our detailed documentation for specifics on data collected and its usage: Analytics: Data and how it's used

Delphix remains committed to transparency regarding data privacy and security.