1 /***********************************************************************
2  * Copyright (c) 2013-2024 Commonwealth Computer Research, Inc.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Apache License, Version 2.0
5  * which accompanies this distribution and is available at
6  * http://www.opensource.org/licenses/apache2.0.php.
7  ***********************************************************************/
8 
9 package org.locationtech.geomesa.metrics.core
10 
11 import com.codahale.metrics._
12 import com.typesafe.config.Config
13 import org.locationtech.geomesa.utils.io.CloseWithLogging
14 
15 import java.io.Closeable
16 
17 /**
18   * Provides namespaced access to reporting metrics
19   *
20   * @param registry metric registry
21   * @param prefix namespace prefix
22   * @param reporters metric reporters
23   */
24 class GeoMesaMetrics(val registry: MetricRegistry, prefix: String, reporters: Seq[ScheduledReporter])
25     extends Closeable {
26 
27   private val pre = GeoMesaMetrics.safePrefix(prefix)
28 
29   protected def id(typeName: String, id: String): String = s"$pre${GeoMesaMetrics.safePrefix(typeName)}$id"
30 
31   /**
32    * Creates a prefixed counter
33    *
34    * @param typeName simple feature type name
35    * @param id short identifier for the metric being counted
36    * @return
37    */
38   def counter(typeName: String, id: String): Counter = registry.counter(this.id(typeName, id))
39 
40   /**
41    * Gets a gauge. Note that it is possible (although unlikely) that the gauge will not be the
42    * one from the supplier, if the id has already been registered
43    *
44    * @param typeName simple feature type name
45    * @param id short identifier for the metric being gauged
46    * @param supplier metric supplier
47    * @return
48    */
49   def gauge(typeName: String, id: String, metric: => Gauge[_]): Gauge[_] = {
50     val ident = this.id(typeName, id)
51     // note: don't use MetricRegistry#gauge(String, MetricSupplier<Gauge>) to support older
52     // metric jars that ship with hbase
53     def getOrCreate(): Gauge[_] = {
54       registry.getMetrics.get(ident) match {
55         case g: Gauge[_] => g
56         case null => registry.register(ident, metric)
57         case m =>
58           throw new IllegalArgumentException(s"${m.getClass.getSimpleName} already registered under the name '$ident'")
59       }
60     }
61 
62     // re-try once to avoid concurrency issues with checking then adding a metric (which should be rare)
63     try { getOrCreate() } catch { case _: IllegalArgumentException => getOrCreate() }
64   }
65 
66   /**
67    * Creates a prefixed histogram
68    *
69    * @param typeName simple feature type name
70    * @param id short identifier for the metric being histogramed
71    * @return
72    */
73   def histogram(typeName: String, id: String): Histogram = registry.histogram(this.id(typeName, id))
74 
75   /**
76    * Creates a prefixed meter
77    *
78    * @param typeName simple feature type name
79    * @param id short identifier for the metric being metered
80    * @return
81    */
82   def meter(typeName: String, id: String): Meter = registry.meter(this.id(typeName, id))
83 
84   /**
85    * Creates a prefixed timer
86    *
87    * @param typeName simple feature type name
88    * @param id short identifier for the metric being timed
89    * @return
90    */
91   def timer(typeName: String, id: String): Timer = registry.timer(this.id(typeName, id))
92 
93   /**
94    * Register a metric. Note that in comparison to most methods in this class, a given identifier
95    * can only be registered once
96    *
97    * @param typeName simple feature type name
98    * @param id short identifier for the metric
99    * @param metric metric to register
100    * @tparam T metric type
101    * @return
102    */
103   def register[T <: Metric](typeName: String, id: String, metric: T): T =
104     registry.register(this.id(typeName, id), metric)
105 
106   override def close(): Unit = CloseWithLogging(reporters)
107 }
108 
109 object GeoMesaMetrics {
110 
111   /**
112     * Create a registry
113     *
114     * @param prefix metric name prefix
115     * @param reporters configs for metric reporters
116     * @return
117     */
118   def apply(prefix: String, reporters: Seq[Config]): GeoMesaMetrics = {
119     val registry = new MetricRegistry()
120     val reps = reporters.map(ReporterFactory.apply(_, registry)).toList
121     new GeoMesaMetrics(registry, prefix, reps)
122   }
123 
124   private def safePrefix(name: String): String = {
125     val replaced = name.replaceAll("[^A-Za-z0-9]", ".")
126     if (replaced.isEmpty || replaced.endsWith(".")) { replaced } else { s"$replaced." }
127   }
128 }