Transaction Metrics Logging

The transaction metrics allows the user to view the detailed information of the operations performed by the DSG. The Transaction metrics logging feature can be enabled at the service level.

For more information about enabling the transaction metrics logging feature, refer to the Table: Service Fields.

The transaction metrics are logged in the gateway.log file in JSON format.

The sample transaction metrics for a REST request is as seen in the following snippet.

The following table describes the parameters available in the transaction metrics for different services.

* -The origin_time_utc and logtype parameters will only be displayed on the Audit Store Dashboards.

By default, the normalize-time-labels flag is configured in the features.json file. If the normalize-time-labels flag is configured, then it converts the default timestamp parameters to normalized timestamp parameters, as shown in the Table: Default and Normalized timestamp parameters.

To access the features.json file, navigate to Settings > System > Files, and under the Cloud Gateway - Settings area, access the features.json file.

The following table shows the default timestamp parameters and the normalized timestamp parameters.

Forwarding Transaction Metrics to Insight

The transaction metrics is also forwarded to Insight and can be viewed on the Audit Store Dashboards.

Ensure that the following prerequisites are met before you view the logs on the Audit Store Dashboards:

• The Analytics component is initialized on the ESA. The initialization of Analytics is required for displaying the Audit Store information on the Audit Store Dashboards.

  For more information about initializing the Analytics, refer to the section Initializing analytics on the ESA in the Protegrity Installation Guide.

  For more information about the audit indexes, refer to the section Understanding the audit index fields in the Protegrity Insight Guide.

• The logs are forwarded to the Audit Store.

  For more information about forwarding the logs, refer to the section Forwarding Audit Logs to Insight.

The following figure shows the sample transaction metrics on the Discover screen of the Audit Store Dashboards.

Note: The index_node, tiebreaker, and index_time_utc parameters are only logged on the Audit Store Dashboards.
For more information about these parameters, refer to the section Understanding the audit index fields in the Protegrity Insight Guide.

The DSG transaction logs are stored in the pty_insight_analytics_dsg_transaction_metrics_9.2 index file. It is recommended to enable the scheduled task to free up the space used by old index files that you do not require. For transaction metrics, edit the Delete DSG Transaction Indices task and enable the task. The scheduled task can be set to n days based on your preference.

For more information about scheduled tasks, refer to the section Using the scheduler in the Protegrity Insight Guide.

Total Time Breakdown for HTTP Request

This section describes the total time taken for processing the HTTP request.

The total_time value is calculated by adding the time taken by the following parameters:

• time_pre_processing: The time an HTTP or REST request waited before it was processed.
• processing_time_request: The time taken for the ruleset to process the request data.
• processing_time_downstream: The time taken to send a request to a downstream system and receive a response from the client.
• processing_time_response: The time taken for the ruleset to process the response data.

The following chart depicts the breakdown of the total time taken for an HTTP request.

The processing_time_downstream value is the difference between the start time of processing the response and the end time of processing a request. The processing_time_dowstream is calculated by considering the time taken by any the following parameters:

• http_outbound_time_queue: The time that the request spent in the queue before being processed.
• http_outbound_namelookup: The time taken to resolve the name.
• http_outbound_time_connect: The time taken to connect to the remote host.
• http_outbound_time_appconnect: The time taken to complete the SSH/TLS handshake.
• http_outbound_time_pretransfer: The time from the start until before the first byte is sent.
• http_outbound_time_starttransfer: The time taken from the start of the request until the first byte was received from the server.
• http_outbound_time_total: Total time that the client library took to process the HTTP request.
• http_outbound_time_redirect: The time, in seconds, it took for all redirection steps including name lookup, connect, pretransfer, and transfer before the final transaction was started.

The following chart depicts the processing time downstream for an HTTP request.