Package io.avaje.metrics.statsd

Interface StatsdReporter.Builder

Enclosing interface:
StatsdReporter
public static interface StatsdReporter.Builder
Builder for the StatsdReporter.

  • Method Details

    • hostname

      StatsdReporter.Builder hostname(String hostname)
      Specify the hostname to use. Default is localhost.

    • port

      StatsdReporter.Builder port(int port)
      Specify the port to use. Default is 8125.

    • tags

      StatsdReporter.Builder tags(String[] tags)
      Specify the common tags to be used on all the reported metrics. Default is no tags.

    • client

      StatsdReporter.Builder client(com.timgroup.statsd.StatsDClient client)
      Specify the StatsD client to use. Default is a NonBlockingStatsDClient.

      When using a custom client, the hostname, port and tags are not used.

    • timedThresholdMicros

      StatsdReporter.Builder timedThresholdMicros(long timedThreshold)
      Specify the threshold in microseconds for timed metrics to be reported. Default is 0.

      Set this to reduce the number of metrics reported for timed metrics.

      For example, if set to 10_000, metrics with a duration less than 10 milliseconds will not be reported.

    • schedule

      StatsdReporter.Builder schedule(int schedule, TimeUnit timeUnit)
      Specify the schedule in seconds. Default is 60 seconds.

    • registry

      StatsdReporter.Builder registry(MetricRegistry registry)
      Specify the Metrics registry to use. If not specified the global registry is used.

    • database

      StatsdReporter.Builder database(io.ebean.Database database)
      Add a database to report on.

    • databaseVerbose

      StatsdReporter.Builder databaseVerbose(io.ebean.Database database)
      Add a database to report on with verbose metrics.

    • reporter

      StatsdReporter.Builder reporter(StatsdReporter.Reporter reporter)
      Add an additional custom reporter.

    • build

      StatsdReporter build()
      Build the reporter.