/
MetricsOps.scala
144 lines (124 loc) · 4.99 KB
/
MetricsOps.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
* Copyright 2013 http4s.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.http4s.metrics
import cats.Foldable
import org.http4s.{Method, Request, Status}
/** Describes an algebra capable of writing metrics to a metrics registry
*/
trait MetricsOps[F[_]] {
/** Increases the count of active requests
*
* @param classifier the classifier to apply
*/
def increaseActiveRequests(classifier: Option[String]): F[Unit]
/** Decreases the count of active requests
*
* @param classifier the classifier to apply
*/
def decreaseActiveRequests(classifier: Option[String]): F[Unit]
/** Records the time to receive the response headers
*
* @param method the http method of the request
* @param elapsed the time to record
* @param classifier the classifier to apply
*/
def recordHeadersTime(method: Method, elapsed: Long, classifier: Option[String]): F[Unit]
/** Records the time to fully consume the response, including the body
*
* @param method the http method of the request
* @param status the http status code of the response
* @param elapsed the time to record
* @param classifier the classifier to apply
*/
def recordTotalTime(
method: Method,
status: Status,
elapsed: Long,
classifier: Option[String]): F[Unit]
/** Record abnormal terminations, like errors, timeouts or just other abnormal terminations.
*
* @param elapsed the time to record
* @param terminationType the type of termination
* @param classifier the classifier to apply
*/
def recordAbnormalTermination(
elapsed: Long,
terminationType: TerminationType,
classifier: Option[String]): F[Unit]
}
object MetricsOps {
/** Given an exclude function, return a 'classifier' function, i.e. for application in
* org.http4s.server/client.middleware.Metrics#apply.
*
* Let's say you want a classifier that excludes integers since your paths consist of:
* * GET /users/{integer} = GET_users_*
* * POST /users = POST_users
* * PUT /users/{integer} = PUT_users_*
* * DELETE /users/{integer} = DELETE_users_*
*
* In such a case, we could use:
*
* classifierFMethodWithOptionallyExcludedPath(
* exclude = { str: String => scala.util.Try(str.toInt).isSuccess },
* excludedValue = "*",
* intercalateValue = "_"
* )
*
* Chris Davenport notes the following on performance considerations of exclude's function value:
*
* > It's worth noting that this runs on every segment of a path. So note that if an intermediate Throwables with
* > Stack traces is known and discarded, there may be a performance penalty, such as the above example with Try(str.toInt).
* > I benchmarked some approaches and regex matches should generally be preferred over Throwable's
* > in this position.
*
* @param exclude For a given String, namely a path value, determine whether the value gets excluded.
* @param excludedValue Indicates the String value to be supplied for an excluded path's field.
* @param pathSeparator Value to use for separating the metrics fields' values
* @return Request[F] => Option[String]
*/
def classifierFMethodWithOptionallyExcludedPath[F[_]](
exclude: String => Boolean,
excludedValue: String = "*",
pathSeparator: String = "_"
): Request[F] => Option[String] = { (request: Request[F]) =>
val initial: String = request.method.name
val pathList: List[String] =
request.pathInfo.segments.map(_.decoded()).toList
val minusExcluded: List[String] = pathList.map { (value: String) =>
if (exclude(value)) excludedValue else value
}
val result: String =
minusExcluded match {
case Nil => initial
case nonEmpty @ _ :: _ =>
initial + pathSeparator + Foldable[List]
.intercalate(nonEmpty, pathSeparator)
}
Some(result)
}
}
/** Describes the type of abnormal termination */
sealed trait TerminationType
object TerminationType {
/** Signals just a generic abnormal termination */
case class Abnormal(rootCause: Throwable) extends TerminationType
/** Signals cancelation */
case object Canceled extends TerminationType
/** Signals an abnormal termination due to an error processing the request, either at the server or client side */
case class Error(rootCause: Throwable) extends TerminationType
/** Signals a client timing out during a request */
case object Timeout extends TerminationType
}