com.aerospike.client.metrics.MetricsPolicy Maven / Gradle / Ivy
Show all versions of aerospike-client-bc-jdk8 Show documentation
/*
* Copyright 2012-2024 Aerospike, Inc.
*
* Portions may be licensed to Aerospike, Inc. under one or more contributor
* license agreements WHICH ARE COMPATIBLE WITH THE APACHE LICENSE, VERSION 2.0.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.aerospike.client.metrics;
import com.aerospike.client.policy.ClientPolicy;
/**
* Client periodic metrics configuration.
*/
public final class MetricsPolicy {
/**
* Listener that handles metrics notification events. The default listener implementation
* writes the metrics snapshot to a file which will later be read and forwarded to
* OpenTelemetry by a separate offline application.
*
* The listener could be overridden to send the metrics snapshot directly to OpenTelemetry.
*/
public MetricsListener listener;
/**
* Directory path to write metrics log files for listeners that write logs.
*
* Default:
*/
public String reportDir = ".";
/**
* Metrics file size soft limit in bytes for listeners that write logs.
*
* When reportSizeLimit is reached or exceeded, the current metrics file is closed and a new
* metrics file is created with a new timestamp. If reportSizeLimit is zero, the metrics file
* size is unbounded and the file will only be closed when
* {@link com.aerospike.client.AerospikeClient#disableMetrics()} or
* {@link com.aerospike.client.AerospikeClient#close()} is called.
*
* Default: 0
*/
public long reportSizeLimit = 0;
/**
* Number of cluster tend iterations between metrics notification events. One tend iteration
* is defined as {@link ClientPolicy#tendInterval} (default 1 second) plus the time to tend all
* nodes.
*
* Default: 30
*/
public int interval = 30;
/**
* Number of elapsed time range buckets in latency histograms.
*
* Default: 7
*/
public int latencyColumns = 7;
/**
* Power of 2 multiple between each range bucket in latency histograms starting at column 3. The bucket units
* are in milliseconds. The first 2 buckets are "<=1ms" and ">1ms". Examples:
*
{@code
* // latencyColumns=7 latencyShift=1
* <=1ms >1ms >2ms >4ms >8ms >16ms >32ms
*
* // latencyColumns=5 latencyShift=3
* <=1ms >1ms >8ms >64ms >512ms
* }
* Default: 1
*/
public int latencyShift = 1;
/**
* Copy constructor.
*/
public MetricsPolicy(MetricsPolicy other) {
this.listener = other.listener;
this.reportDir = other.reportDir;
this.reportSizeLimit = other.reportSizeLimit;
this.interval = other.interval;
this.latencyColumns = other.latencyColumns;
this.latencyShift = other.latencyShift;
}
/**
* Default constructor.
*/
public MetricsPolicy() {
}
// Include setters to facilitate Spring's ConfigurationProperties.
public void setListener(MetricsListener listener) {
this.listener = listener;
}
public void setReportDir(String reportDir) {
this.reportDir = reportDir;
}
public void setReportSizeLimit(long reportSizeLimit) {
this.reportSizeLimit = reportSizeLimit;
}
public void setInterval(int interval) {
this.interval = interval;
}
public void setLatencyColumns(int latencyColumns) {
this.latencyColumns = latencyColumns;
}
public void setLatencyShift(int latencyShift) {
this.latencyShift = latencyShift;
}
}