1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api.technical.monitoring
21 import grizzled.slf4j.Logging
22 import kamon.Kamon
23 import kamon.metric.{DynamicRange, Histogram, MeasurementUnit}
24 import kamon.tag.TagSet
25 import org.make.api.technical.tracking.FrontPerformanceTimings
26 
27 import scala.concurrent.duration.DurationInt
28 import scala.util.{Failure, Success, Try}
29 
30 trait MonitoringService {
31   def monitorPerformance(applicationName: String, metrics: FrontPerformanceTimings): Unit
32 }
33 
34 trait MonitoringServiceComponent {
35   def monitoringService: MonitoringService
36 }
37 
38 final case class HistogramName(applicationName: String, metricName: String) {
39   def fullMetricName: String = s"loadtime.$applicationName.$metricName"
40 }
41 
42 trait DefaultMonitoringService extends MonitoringServiceComponent with Logging {
43   override lazy val monitoringService: MonitoringService = new DefaultMonitoringService
44 
45   class DefaultMonitoringService extends MonitoringService {
46 
47     private val maxLoadingTime: Long = 1.minute.toMillis
48     private val range: DynamicRange = DynamicRange(1L, maxLoadingTime, 2)
49 
50     private var histograms: Map[HistogramName, Histogram] = Map.empty
51 
52     private def getHistogram(histogramName: HistogramName): Histogram = {
53       if (!histograms.contains(histogramName)) {
54         val value =
55           Kamon
56             .histogram(name = "load_time", unit = MeasurementUnit.time.milliseconds, dynamicRange = range)
57             .withTags(
58               TagSet.from(
59                 Map(
60                   "application" -> MonitoringMessageHelper.format(histogramName.applicationName),
61                   "metric" -> histogramName.metricName
62                 )
63               )
64             )
65 
66         histograms += histogramName -> value
67       }
68       histograms(histogramName)
69     }
70 
71     private def recordIfPositive(applicationName: String, metric: String, value: Long): Unit = {
72       if (value >= 0) {
73         Try(getHistogram(HistogramName(applicationName, metric)).record(value)) match {
74           case Success(_) =>
75           case Failure(e) =>
76             logger.error(s"Error when logging value $value for metric $metric on application $applicationName", e)
77         }
78       }
79     }
80 
81     override def monitorPerformance(applicationName: String, metrics: FrontPerformanceTimings): Unit = {
82       recordIfPositive(applicationName, "connect", metrics.connectEnd - metrics.connectStart)
83       recordIfPositive(applicationName, "domain_lookup", metrics.domainLookupEnd - metrics.domainLookupStart)
84       recordIfPositive(applicationName, "dom_complete", metrics.domComplete - metrics.responseEnd)
85       recordIfPositive(applicationName, "dom_interactive", metrics.domInteractive - metrics.responseEnd)
86       recordIfPositive(applicationName, "dom_loading", metrics.domLoading - metrics.responseEnd)
87       recordIfPositive(applicationName, "request_time", metrics.responseEnd - metrics.requestStart)
88       recordIfPositive(applicationName, "first_byte", metrics.responseStart - metrics.requestStart)
89       recordIfPositive(applicationName, "transfer_time", metrics.responseEnd - metrics.responseStart)
90     }
91   }
92 }
93 
94 object MonitoringMessageHelper {
95   def format(value: String): String = value.filterNot(_ < ' ').replace("\"", "\\\"")
96 }