Package com.aerospike.client.metrics

Class MetricsPolicy

java.lang.Object
com.aerospike.client.metrics.MetricsPolicy
public final class MetricsPolicy extends Object
Client periodic metrics configuration.

  • Field Details

    • listener

      public MetricsListener listener
      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.

    • reportDir

      public String reportDir
      Directory path to write metrics log files for listeners that write logs.

      Default:

    • reportSizeLimit

      public long reportSizeLimit
      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 AerospikeClient.disableMetrics() or AerospikeClient.close() is called.

      Default: 0

    • interval

      public int interval
      Number of cluster tend iterations between metrics notification events. One tend iteration is defined as ClientPolicy.tendInterval (default 1 second) plus the time to tend all nodes.

      Default: 30

    • latencyColumns

      public int latencyColumns
      Number of elapsed time range buckets in latency histograms.

      Default: 7

    • latencyShift

      public int latencyShift
      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: 
      
 // latencyColumns=7 latencyShift=1
 <=1ms >1ms >2ms >4ms >8ms >16ms >32ms

 // latencyColumns=5 latencyShift=3
 <=1ms >1ms >8ms >64ms >512ms
      Default: 1

    • labels

      public Map<String,String> labels
      Labels that can be sent to the metrics output

  • Constructor Details

    • MetricsPolicy

      public MetricsPolicy(MetricsPolicy other, com.aerospike.client.configuration.serializers.Configuration config, boolean metricsEnabled)
      Copy metrics policy from another metrics policy AND override certain policy attributes if they exist in the configProvider.

    • MetricsPolicy

      public MetricsPolicy(MetricsPolicy other)
      Copy constructor.

    • MetricsPolicy

      public MetricsPolicy()
      Default constructor.

  • Method Details

    • setListener

      public void setListener(MetricsListener listener)

    • setReportDir

      public void setReportDir(String reportDir)

    • setReportSizeLimit

      public void setReportSizeLimit(long reportSizeLimit)

    • setInterval

      public void setInterval(int interval)

    • setLatencyColumns

      public void setLatencyColumns(int latencyColumns)

    • setLatencyShift

      public void setLatencyShift(int latencyShift)

    • setLabels

      public void setLabels(Map<String,String> labels)

    • isMetricsRestartRequired

      public boolean isMetricsRestartRequired()

    • setMetricsRestartRequired

      public void setMetricsRestartRequired(boolean metricsRestartRequired)