feat: micrometer-statsd (#43)

* WIP

* feat: Implement micrometer-statsd module with PureConfig interop

refactor: Make micrometer-jmx more configurable

* refactor: Remove custom and unneeded datatypes that were just mirroring original types

Author: jakubjanecek

build.sbt

@@ -32,6 +32,7 @@ lazy val root = project
     jvmPureConfig,
     micrometerJmx,
     micrometerJmxPureConfig,
+    micrometerStatsD,
     pureConfig
   )
   .settings(
@@ -171,6 +172,23 @@ lazy val micrometerJmxPureConfig = project
   .settings(commonSettings)
   .settings(name := "sst-micrometer-jmx-pureconfig")
 
+lazy val micrometerStatsD = project
+  .in(file("micrometer-statsd"))
+  .settings(commonSettings)
+  .settings(
+    name := "sst-micrometer-statsd",
+    libraryDependencies ++= Seq(
+      Dependencies.micrometerStatsD,
+      Dependencies.jsr305 // required because of Scala compiler
+    )
+  )
+
+lazy val micrometerStatsDPureConfig = project
+  .in(file("micrometer-statsd-pureconfig"))
+  .dependsOn(micrometerStatsD, pureConfig)
+  .settings(commonSettings)
+  .settings(name := "sst-micrometer-statsd-pureconfig")
+
 lazy val pureConfig = project
   .in(file("pureconfig"))
   .settings(commonSettings)

micrometer-jmx/src/main/scala/com/avast/sst/micrometer/jmx/MicrometerJmxConfig.scala

@@ -1,3 +1,9 @@
 package com.avast.sst.micrometer.jmx
 
-final case class MicrometerJmxConfig(domain: String, enableTypeScopeNameHierarchy: Boolean = false)
+import java.util.concurrent.TimeUnit
+
+import scala.concurrent.duration.Duration
+
+final case class MicrometerJmxConfig(domain: String,
+                                     enableTypeScopeNameHierarchy: Boolean = false,
+                                     step: Duration = Duration(1, TimeUnit.MINUTES))

micrometer-jmx/src/main/scala/com/avast/sst/micrometer/jmx/MicrometerJmxModule.scala

@@ -1,5 +1,7 @@
 package com.avast.sst.micrometer.jmx
 
+import java.time.Duration
+
 import cats.effect.{Resource, Sync}
 import com.codahale.metrics.MetricRegistry
 import com.codahale.metrics.jmx.JmxReporter
@@ -14,23 +16,25 @@ object MicrometerJmxModule {
 
   /** Makes configured [[io.micrometer.jmx.JmxMeterRegistry]]. */
   @SuppressWarnings(Array("org.wartremover.warts.NonUnitStatements"))
-  def make[F[_]: Sync](config: MicrometerJmxConfig): Resource[F, JmxMeterRegistry] = {
+  def make[F[_]: Sync](config: MicrometerJmxConfig,
+                       clock: Clock = Clock.SYSTEM,
+                       nameMapper: HierarchicalNameMapper = HierarchicalNameMapper.DEFAULT): Resource[F, JmxMeterRegistry] = {
     Resource
       .make {
         Sync[F].delay {
           if (config.enableTypeScopeNameHierarchy) {
             val dropwizardRegistry = new MetricRegistry
             val registry = new JmxMeterRegistry(
-              new DomainJmxConfig(config.domain),
-              Clock.SYSTEM,
-              HierarchicalNameMapper.DEFAULT,
+              new CustomJmxConfig(config),
+              clock,
+              nameMapper,
               dropwizardRegistry,
               makeJmxReporter(dropwizardRegistry, config.domain)
             )
             registry.config.namingConvention(NamingConvention.dot)
             registry
           } else {
-            new JmxMeterRegistry(new DomainJmxConfig(config.domain), Clock.SYSTEM)
+            new JmxMeterRegistry(new CustomJmxConfig(config), clock, nameMapper)
           }
         }
       }(registry => Sync[F].delay(registry.close()))
@@ -44,9 +48,12 @@ object MicrometerJmxModule {
       .build
   }
 
-  private class DomainJmxConfig(override val domain: String) extends JmxConfig {
+  private class CustomJmxConfig(c: MicrometerJmxConfig) extends JmxConfig {
+
+    override val domain: String = c.domain
+    override val step: Duration = Duration.ofMillis(c.step.toMillis)
 
-    // implements MeterRegistryConfig.get which can return null according to JavaDoc and @Nullable annotation
+    // the method is @Nullable and we don't need to implement it here
     @SuppressWarnings(Array("org.wartremover.warts.Null"))
     override def get(key: String): String = null
 

micrometer-statsd-pureconfig/src/main/scala/com/avast/sst/micrometer/statsd/pureconfig/ConfigReaders.scala

@@ -0,0 +1,11 @@
+package com.avast.sst.micrometer.statsd.pureconfig
+
+import com.avast.sst.micrometer.statsd.MicrometerStatsDConfig
+import pureconfig.ConfigReader
+import pureconfig.generic.semiauto.deriveReader
+
+trait ConfigReaders {
+
+  implicit val micrometerStatsDConfigReader: ConfigReader[MicrometerStatsDConfig] = deriveReader
+
+}

micrometer-statsd-pureconfig/src/main/scala/com/avast/sst/micrometer/statsd/pureconfig/implicits.scala

@@ -0,0 +1,3 @@
+package com.avast.sst.micrometer.statsd.pureconfig
+
+object implicits extends ConfigReaders

micrometer-statsd/src/main/scala/com/avast/sst/micrometer/statsd/MicrometerStatsDConfig.scala

@@ -0,0 +1,18 @@
+package com.avast.sst.micrometer.statsd
+
+import java.util.concurrent.TimeUnit
+
+import io.micrometer.statsd.{StatsdFlavor, StatsdProtocol}
+
+import scala.concurrent.duration.Duration
+
+final case class MicrometerStatsDConfig(host: String,
+                                        port: Int = 8125,
+                                        flavor: StatsdFlavor = StatsdFlavor.ETSY,
+                                        enabled: Boolean = true,
+                                        protocol: StatsdProtocol = StatsdProtocol.UDP,
+                                        maxPacketLength: Int = 1400,
+                                        pollingFrequency: Duration = Duration(10, TimeUnit.SECONDS),
+                                        step: Duration = Duration(1, TimeUnit.MINUTES),
+                                        publishUnchangedMeters: Boolean = true,
+                                        buffered: Boolean = true)

micrometer-statsd/src/main/scala/com/avast/sst/micrometer/statsd/MicrometerStatsDModule.scala

@@ -0,0 +1,58 @@
+package com.avast.sst.micrometer.statsd
+
+import java.time.Duration
+
+import cats.effect.{Resource, Sync}
+import io.micrometer.core.instrument.Clock
+import io.micrometer.core.instrument.util.HierarchicalNameMapper
+import io.micrometer.statsd.{StatsdConfig, StatsdFlavor, StatsdMeterRegistry, StatsdProtocol}
+
+import scala.language.higherKinds
+
+object MicrometerStatsDModule {
+
+  /** Makes configured [[io.micrometer.statsd.StatsdMeterRegistry]]. */
+  def make[F[_]: Sync](config: MicrometerStatsDConfig,
+                       clock: Clock = Clock.SYSTEM,
+                       nameMapper: HierarchicalNameMapper = HierarchicalNameMapper.DEFAULT): Resource[F, StatsdMeterRegistry] = {
+    Resource
+      .make {
+        Sync[F].delay {
+          StatsdMeterRegistry
+            .builder(new CustomStatsdConfig(config))
+            .clock(clock)
+            .nameMapper(nameMapper)
+            .build
+        }
+      }(registry => Sync[F].delay(registry.close()))
+  }
+
+  private class CustomStatsdConfig(c: MicrometerStatsDConfig) extends StatsdConfig {
+
+    override val flavor: StatsdFlavor = c.flavor
+
+    override val enabled: Boolean = c.enabled
+
+    override val host: String = c.host
+
+    override val port: Int = c.port
+
+    override val protocol: StatsdProtocol = c.protocol
+
+    override val maxPacketLength: Int = c.maxPacketLength
+
+    override val pollingFrequency: Duration = java.time.Duration.ofMillis(c.pollingFrequency.toMillis)
+
+    override val step: Duration = java.time.Duration.ofMillis(c.step.toMillis)
+
+    override val publishUnchangedMeters: Boolean = c.publishUnchangedMeters
+
+    override val buffered: Boolean = c.buffered
+
+    // the method is @Nullable and we don't need to implement it here
+    @SuppressWarnings(Array("org.wartremover.warts.Null"))
+    override def get(key: String): String = null
+
+  }
+
+}

project/Dependencies.scala

@@ -12,6 +12,7 @@ object Dependencies {
   val logbackClassic = "ch.qos.logback" % "logback-classic" % "1.2.3"
   val micrometerCore = "io.micrometer" % "micrometer-core" % Versions.micrometer
   val micrometerJmx = "io.micrometer" % "micrometer-registry-jmx" % Versions.micrometer
+  val micrometerStatsD = "io.micrometer" % "micrometer-registry-statsd" % Versions.micrometer
   val monixEval = "io.monix" %% "monix-eval" % "3.0.0"
   val pureConfig = "com.github.pureconfig" %% "pureconfig" % "0.12.1"
   val scalaTest = "org.scalatest" %% "scalatest" % "3.0.8"