Configuring Histogram Timers for Connectors¶

This guide describes how to configure Histogram Timers for Privacera connectors. These properties allow you to enable percentile dashboards.

Configuration Steps¶

To configure histogram timers, add properties to the policysync-custom.properties file. Create the policysync-custom.properties file by following the instructions in Configure Custom Properties for Connectors.

1. Set default category for all Timer metrics¶

By default, the default category is set to empty. To enable histogram metrics, set the default category to sub-second. The other pre-defined categories are sub-minute and sub-hour.

Bash

metrics.timer.slo.default.category=sub-second

2. Modify the buckets for sub-second histograms¶

The default buckets for various categories are -

Text Only
1 2 3 4	`# Category definitions metrics.timer.slo.category.sub-second=10ms,100ms,500ms,1s metrics.timer.slo.category.sub-minute=100ms,1s,5s,30s metrics.timer.slo.category.sub-hour=1s,10s,1m,5m`

You can override the category buckets as follows - example shows that we have overriden for the sub-second category. Similarly, you can create a new category and assign buckets to it. You can set this new category as the default for all Timer metrics or set to specific metrics.

Warning

Adding more buckets increases the number of time-series that are generated per Timer metric.

Bash

metrics.timer.slo.category.sub-second=50ms,100ms,250ms,500ms,750ms,1s

3. Override the buckets for a specific metric¶

You can override the buckets for a specific metric. In this example, the metric resource.load.time gets it's own set of custom buckets.

Bash

metrics.timer.slo.override.resource.load.time=1s,5s,10s

4. Override the category for a specific metric¶

You can override the bucket category for a specific metric. In this example, the metric full.sync.time is assigned the sub-hour bucket category.

Bash

metrics.timer.slo.override_category.full.sync.time=sub-hour

5. Deploy Your Changes¶

Once the properties are configured, run the following commands to update your Privacera Manager platform instance:

Step 1 - Setup which generates the helm charts. This step usually takes few minutes.

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

Step 2 - Apply the Privacera Manager helm charts.

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

Step 3 - (Optional) Post-installation step which generates Plugin tar ball, updates Route 53 DNS and so on. This step is not required if you are updating only connector properties.

Bash
cd ~/privacera/privacera-manager
./privacera-manager.sh post-install

Advanced Configuration