Skip to main content

Installation and Administration Guide

Viewing Data Plane Metrics

As a system administrator, once you perform all of the setup steps in Monitoring the Privitar Data Security Platform​, you can use tools such as Bitnami Prometheus to view data plane metrics.

  1. Determine the pods for the data plane namespace:

    kubectl get pods -n data-plane
  2. Install Prometheus into the same namespace:

    helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
    helm repo add stable https://kubernetes-charts.storage.googleapis.com/
    helm repo update
    helm install prometheus prometheus-community/prometheus -n data-plane
  3. View the pods that are now in the data plane namespace:

    kubectl get pods -n data-plane
  4. Perform a port forward of the Prometheus server pod to your local machine:

    kubectl --namespace data-plane port-forward prometheus-server-xxxx 9090:9090
  5. In your web browser, navigate to the Prometheus user interface (UI):

    http://localhost:9090
  6. Run some queries on the data plane.

  7. From the query bar of the Prometheus UI, click to reveal the available metrics.

  8. Enter the following sample query in the query bar:

    com_privitar_data_proxy_jdbc_handler_seconds_max{action="prepare"}
  9. Click Execute.

  10. Review the values on the right side of the page.

Table 52. Data Plane Metrics

Group

Metric Name

Description

Action Filter

Action Filter Description

Query Engine Database Connections

  • com_privitar_query_engine_db_connections_idle

  • com_privitar_query_engine_db_connections_total

  • com_privitar_query_engine_db_connections_active

  • Number of idle connections to underlying databases

  • Total number of connections to underlying databases

  • Number of active connections to underlying databases

N/A

N/A

Data Proxy JDBC Handler

  • com_privitar_data_proxy_jdbc_handler_seconds_max

  • com_privitar_data_proxy_jdbc_handler_seconds_sum

  • com_privitar_data_proxy_jdbc_handler_seconds_count

  • The maximum number of seconds taken for a specified action on the data proxy

  • The sum of the number of seconds taken for specified actions on the data proxy

  • The count of specified actions on the data proxy

The sum divided by the count equals the average.

  • prepare

  • prepare_and_execute

  • open_connection

  • get_database_properties

  • create_statement

  • connection_sync

  • close_statement

  • close_connection

  • Time taken to prepare a prepared statement (parse the query, fetch policies and metadata, and rewrite query). This event is triggered for prepared SQL statements that you typically run from a program, with variables used to replace parts of the query.

  • Time taken to prepare a prepared statement (parse the query, fetch policies and metadata, and rewrite query) and execute it. This event is typically triggered when you are using a normal statement (such as through an interactive session where you issue a SQL query on the fly), not a prepared statement. It includes all the prepare and execution time. For this metric, as it pertains to the data proxy, it also includes fetching the first 100 rows of data.

For this metric, as it pertains to the data proxy, it also includes fetching the first 100 rows of data.

Privitar Query Engine JDBC Handler

  • com_privitar_query_engine_jdbc_handler_seconds_max

  • com_privitar_query_engine_jdbc_handler_seconds_sum

  • com_privitar_query_engine_jdbc_handler_seconds_count

  • The maximum number of seconds taken for a specified action on the data proxy

  • The sum of the number of seconds taken for specified actions on the data proxy

  • The count of specified actions on the data proxy

The sum divided by the count equals the average.

  • prepare

  • prepare_and_execute

  • open_connection

  • get_database_properties

  • create_statement

  • connection_sync

  • close_statement

  • close_connection

  • Time taken to prepare a prepared statement (parse the query, fetch policies and metadata, and rewrite query). This event is triggered for prepared SQL statements that you typically run from a program, with variables used to replace parts of the query.

  • Time taken to prepare a prepared statement (parse the query, fetch policies and metadata, and rewrite query) and execute it. This event is typically triggered when you are using a normal statement (such as through an interactive session where you issue a SQL query on the fly), not a prepared statement. It includes all the prepare and execution time. For this metric, as it pertains to the data proxy, it also includes fetching the first 100 rows of data.