Skip to content

Configure Diagnostics Client Advanced Settings

This document provides instructions on how to configure advanced settings for the Privacera Diagnostics Client. These settings allow you to customize client behavior, network timeouts, heartbeat intervals and test execution intervals to better suit your organization's needs.

Note

  • All configuration variables are optional and have default values.
  • Uncomment and set values only if you need to override the defaults.

To configure Diagnostics Client advanced settings, perform the following steps:

  1. Copy vars.privacera-diagnostics.yml from sample-vars and open it to configure. If the file is already present, you can skip this step:

    Bash
    1
2
3
    cd ~/privacera/privacera-manager
cp config/sample-vars/vars.privacera-diagnostics.yml config/custom-vars
vi config/custom-vars/vars.privacera-diagnostics.yml

  2. Uncomment and update the following variables in vars.privacera-diagnostics.yml as needed:

    Variable Name Description Default Value
    DIAG_CLIENT_HEARTBEAT_INTERVAL_SECS Set the interval in seconds between client heartbeat signals sent to the Diagnostics Server 30
    DIAG_CLIENT_NETWORK_TIMEOUT_SECS Set the network timeout in seconds for client network operations 5
    DIAG_CLIENT_DB_CONNECTION_TIMEOUT_SECS Set the timeout in seconds for database connection attempts from the Diagnostics Client 10
    DIAG_TESTS_INITIAL_WAIT_SECS Set the initial wait time in seconds before starting diagnostic tests 120
    DIAG_TESTS_INTERVAL_SECS Set the interval in seconds between test runs when tests are successful 86400
    DIAG_TESTS_RETRY_ENABLED Enable or disable retry functionality for failed test runs false
    DIAG_TESTS_RETRY_INTERVAL_SECS Set the retry interval in seconds between test runs when tests fail 43200
    DIAG_TEST_RESULTS_FILE_RETENTION_COUNT Set the global retention count for test results files. Applies to all services if not overridden by service-specific settings
    [Service-specific retention > Global retention > Default (7 days)]    		 7
    DIAG_TEST_RESULTS_RETENTION_AUDITSERVER Set the retention count for Audit Server test results 7
    DIAG_TEST_RESULTS_RETENTION_RANGER Set the retention count for Ranger test results 7
    DIAG_TEST_RESULTS_RETENTION_PORTAL Set the retention count for Portal test results 7
    DIAG_TEST_RESULTS_RETENTION_MARIADB Set the retention count for MariaDB test results 7
    DIAG_TEST_RESULTS_RETENTION_ZOOKEEPER Set the retention count for Zookeeper test results 7
    DIAG_TEST_RESULTS_RETENTION_SOLR Set the retention count for Solr test results 7
    DIAG_TEST_RESULTS_RETENTION_K8SKAFKA Set the retention count for K8S Kafka test results 7
    DIAG_TEST_RESULTS_RETENTION_{CONNECTOR_NAME} Set the retention count for specified connector test result.
    Example: If you want to add it for databricks-unity-catalog connector → DIAG_TEST_RESULTS_RETENTION_DATABRICKS_UNITY_CATALOG.
    ie., Hyphens (-) in the connector name must be converted to underscores (_)    		 7

  3. Save and close the file.

  4. Generate the Helm charts. This step prepares the necessary Kubernetes configurations for deploying the Privacera services:

    Bash
    1
2
    cd ~/privacera/privacera-manager
./privacera-manager.sh setup

  5. Apply the Helm charts. This will deploy the Privacera services to your Kubernetes cluster:

    Bash
    1
2
    cd ~/privacera/privacera-manager
./pm_with_helm.sh upgrade