Package io.dropwizard.metrics5

Class CsvReporter.Builder

java.lang.Object
io.dropwizard.metrics5.CsvReporter.Builder
Enclosing class:
CsvReporter
public static class CsvReporter.Builder extends Object
A builder for CsvReporter instances. Defaults to using the default locale, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

  • Method Details

    • shutdownExecutorOnStop

      public CsvReporter.Builder shutdownExecutorOnStop(boolean shutdownExecutorOnStop)
      Specifies whether or not, the executor (used for reporting) will be stopped with same time with reporter. Default value is true. Setting this parameter to false, has the sense in combining with providing external managed executor via scheduleOn(ScheduledExecutorService).
      Parameters:
      shutdownExecutorOnStop - if true, then executor will be stopped in same time with this reporter
      Returns:
      this

    • scheduleOn

      public CsvReporter.Builder scheduleOn(ScheduledExecutorService executor)
      Specifies the executor to use while scheduling reporting of metrics. Default value is null. Null value leads to executor will be auto created on start.
      Parameters:
      executor - the executor to use while scheduling reporting of metrics.
      Returns:
      this

    • formatFor

      public CsvReporter.Builder formatFor(Locale locale)
      Format numbers for the given Locale.
      Parameters:
      locale - a Locale
      Returns:
      this

    • convertRatesTo

      public CsvReporter.Builder convertRatesTo(TimeUnit rateUnit)
      Convert rates to the given time unit.
      Parameters:
      rateUnit - a unit of time
      Returns:
      this

    • convertDurationsTo

      public CsvReporter.Builder convertDurationsTo(TimeUnit durationUnit)
      Convert durations to the given time unit.
      Parameters:
      durationUnit - a unit of time
      Returns:
      this

    • withSeparator

      public CsvReporter.Builder withSeparator(String separator)
      Use the given string to use as the separator for values.
      Parameters:
      separator - the string to use for the separator.
      Returns:
      this

    • withClock

      public CsvReporter.Builder withClock(Clock clock)
      Use the given Clock instance for the time.
      Parameters:
      clock - a Clock instance
      Returns:
      this

    • filter

      public CsvReporter.Builder filter(MetricFilter filter)
      Only report metrics which match the given filter.
      Parameters:
      filter - a MetricFilter
      Returns:
      this

    • withCsvFileProvider

      public CsvReporter.Builder withCsvFileProvider(CsvFileProvider csvFileProvider)

    • build

      public CsvReporter build(File directory)
      Builds a CsvReporter with the given properties, writing .csv files to the given directory.
      Parameters:
      directory - the directory in which the .csv files will be created
      Returns:
      a CsvReporter