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.convert2.metrics
10 
11 import com.codahale.metrics._
12 import com.typesafe.config.Config
13 import org.geotools.api.feature.simple.SimpleFeatureType
14 import org.locationtech.geomesa.convert2.metrics.ConverterMetrics.SimpleGauge
15 import org.locationtech.geomesa.metrics.core.GeoMesaMetrics
16 import org.locationtech.geomesa.utils.conf.GeoMesaSystemProperties.SystemProperty
17 
18 /**
19   * Provides namespaced access to reporting metrics
20   *
21   * @param registry metric registry
22   * @param prefix namespace prefix
23   * @param typeName simple feature type name being processed
24   * @param reporters metric reporters
25   */
26 class ConverterMetrics(
27     registry: MetricRegistry,
28     prefix: Option[String],
29     typeName: String,
30     reporters: Seq[ScheduledReporter]
31   ) extends GeoMesaMetrics(registry, s"${prefix.map(_ + ".").getOrElse("")}geomesa.convert", reporters) {
32 
33   /**
34     * Creates a prefixed counter
35     *
36     * @param id short identifier for the metric being counted
37     * @return
38     */
39   def counter(id: String): Counter = super.counter(typeName, id)
40 
41   /**
42     * Gets an updatable gauge
43     *
44     * @param id short identifier for hte metric being gauged
45     * @tparam T gauge type
46     * @return
47     */
48   def gauge[T](id: String): SimpleGauge[T] =
49     super.gauge(typeName, id, new SimpleGauge()).asInstanceOf[SimpleGauge[T]]
50 
51   /**
52     * Creates a prefixed histogram
53     *
54     * @param id short identifier for the metric being histogramed
55     * @return
56     */
57   def histogram(id: String): Histogram = super.histogram(typeName, id)
58 
59   /**
60     * Creates a prefixed meter
61     *
62     * @param id short identifier for the metric being metered
63     * @return
64     */
65   def meter(id: String): Meter = super.meter(typeName, id)
66 
67   /**
68     * Creates a prefixed timer
69     *
70     * @param id short identifier for the metric being timed
71     * @return
72     */
73   def timer(id: String): Timer = super.timer(typeName, id)
74 
75   /**
76     * Register a metric
77     *
78     * @param id short identifier for the metric
79     * @param metric metric to register
80     * @tparam T metric type
81     * @return
82     */
83   def register[T <: Metric](id: String, metric: T): T = super.register(typeName, id, metric)
84 
85   override def close(): Unit = {
86     // execute a final report before closing, for situations where the converter runs too quickly to report anything
87     try { reporters.foreach(_.report()) } finally {
88       super.close()
89     }
90   }
91 }
92 
93 object ConverterMetrics {
94 
95   val MetricsPrefix: SystemProperty = SystemProperty("geomesa.convert.validators.prefix")
96 
97   /**
98     * Creates an empty registry with no namespace or reporters
99     *
100     * @return
101     */
102   def empty: ConverterMetrics = new ConverterMetrics(new MetricRegistry(), None, "", Seq.empty)
103 
104   /**
105     * Create a registry for the provided feature type
106     *
107     * @param sft simple feature type
108     * @param reporters configs for metric reporters
109     * @return
110     */
111   def apply(sft: SimpleFeatureType, reporters: Seq[Config]): ConverterMetrics = {
112     val registry = new MetricRegistry()
113     val reps = reporters.map(org.locationtech.geomesa.metrics.core.ReporterFactory.apply(_, registry)).toList
114     new ConverterMetrics(registry, MetricsPrefix.option, sft.getTypeName, reps)
115   }
116 
117   /**
118     * Simple gauge that can be updated
119     *
120     * @tparam T value
121     */
122   class SimpleGauge[T] extends Gauge[T] {
123 
124     @volatile
125     private var value: T = _
126 
127     override def getValue: T = value
128 
129     def set(value: T): Unit = this.value = value
130   }
131 }