|
| 1 | +package sttp.client4.opentelemetry.otel4s |
| 2 | + |
| 3 | +import java.util.concurrent.TimeUnit |
| 4 | + |
| 5 | +import cats.Monad |
| 6 | +import cats.effect.Clock |
| 7 | +import cats.syntax.flatMap._ |
| 8 | +import cats.syntax.functor._ |
| 9 | +import cats.syntax.foldable._ |
| 10 | +import org.typelevel.otel4s.Attributes |
| 11 | +import org.typelevel.otel4s.metrics.{BucketBoundaries, Histogram, MeterProvider, UpDownCounter} |
| 12 | +import org.typelevel.otel4s.semconv.attributes.{ |
| 13 | + ErrorAttributes, |
| 14 | + HttpAttributes, |
| 15 | + NetworkAttributes, |
| 16 | + ServerAttributes, |
| 17 | + UrlAttributes |
| 18 | +} |
| 19 | +import sttp.client4.listener.{ListenerBackend, RequestListener} |
| 20 | +import sttp.client4._ |
| 21 | +import sttp.model.{HttpVersion, StatusCode} |
| 22 | +import sttp.client4.wrappers.FollowRedirectsBackend |
| 23 | + |
| 24 | +import scala.concurrent.duration.FiniteDuration |
| 25 | +import scala.util.chaining._ |
| 26 | + |
| 27 | +object Otel4sMetricsBackend { |
| 28 | + |
| 29 | + def apply[F[_]: Monad: Clock: MeterProvider]( |
| 30 | + delegate: Backend[F], |
| 31 | + config: Otel4sMetricsConfig |
| 32 | + ): F[Backend[F]] = |
| 33 | + for { |
| 34 | + listener <- metricsListener(config) |
| 35 | + } yield FollowRedirectsBackend(ListenerBackend(delegate, listener)) |
| 36 | + |
| 37 | + def apply[F[_]: Monad: Clock: MeterProvider]( |
| 38 | + delegate: WebSocketBackend[F], |
| 39 | + config: Otel4sMetricsConfig |
| 40 | + ): F[WebSocketBackend[F]] = |
| 41 | + for { |
| 42 | + listener <- metricsListener(config) |
| 43 | + } yield FollowRedirectsBackend(ListenerBackend(delegate, listener)) |
| 44 | + |
| 45 | + def apply[F[_]: Monad: Clock: MeterProvider, S]( |
| 46 | + delegate: StreamBackend[F, S], |
| 47 | + config: Otel4sMetricsConfig |
| 48 | + ): F[StreamBackend[F, S]] = |
| 49 | + for { |
| 50 | + listener <- metricsListener(config) |
| 51 | + } yield FollowRedirectsBackend(ListenerBackend(delegate, listener)) |
| 52 | + |
| 53 | + def apply[F[_]: Monad: Clock: MeterProvider, S]( |
| 54 | + delegate: WebSocketStreamBackend[F, S], |
| 55 | + config: Otel4sMetricsConfig |
| 56 | + ): F[WebSocketStreamBackend[F, S]] = |
| 57 | + for { |
| 58 | + listener <- metricsListener(config) |
| 59 | + } yield FollowRedirectsBackend(ListenerBackend(delegate, listener)) |
| 60 | + |
| 61 | + private def metricsListener[F[_]: Monad: Clock: MeterProvider, P]( |
| 62 | + config: Otel4sMetricsConfig |
| 63 | + ): F[MetricsRequestListener[F]] = |
| 64 | + for { |
| 65 | + meter <- MeterProvider[F].meter("sttp-client4").withVersion("1.0.0").get |
| 66 | + |
| 67 | + requestDuration <- meter |
| 68 | + .histogram[Double]("http.client.request.duration") |
| 69 | + .withExplicitBucketBoundaries(config.requestDurationHistogramBuckets) |
| 70 | + .withDescription("Duration of HTTP client requests.") |
| 71 | + .withUnit("s") |
| 72 | + .create |
| 73 | + |
| 74 | + requestBodySize <- meter |
| 75 | + .histogram[Long]("http.client.request.body.size") |
| 76 | + .pipe(b => config.requestBodySizeHistogramBuckets.fold(b)(b.withExplicitBucketBoundaries)) |
| 77 | + .withDescription("Size of HTTP client request bodies.") |
| 78 | + .withUnit("By") |
| 79 | + .create |
| 80 | + |
| 81 | + responseBodySize <- meter |
| 82 | + .histogram[Long]("http.client.response.body.size") |
| 83 | + .pipe(b => config.responseBodySizeHistogramBuckets.fold(b)(b.withExplicitBucketBoundaries)) |
| 84 | + .withDescription("Size of HTTP client response bodies.") |
| 85 | + .withUnit("By") |
| 86 | + .create |
| 87 | + |
| 88 | + activeRequests <- meter |
| 89 | + .upDownCounter[Long]("http.client.active_requests") |
| 90 | + .withDescription("Number of active HTTP requests.") |
| 91 | + .withUnit("{request}") |
| 92 | + .create |
| 93 | + } yield new MetricsRequestListener[F]( |
| 94 | + requestDuration, |
| 95 | + requestBodySize, |
| 96 | + responseBodySize, |
| 97 | + activeRequests |
| 98 | + ) |
| 99 | + |
| 100 | + private final case class State(start: FiniteDuration, activeRequestsAttributes: Attributes) |
| 101 | + |
| 102 | + private final class MetricsRequestListener[F[_]: Monad: Clock]( |
| 103 | + requestDuration: Histogram[F, Double], |
| 104 | + requestBodySize: Histogram[F, Long], |
| 105 | + responseBodySize: Histogram[F, Long], |
| 106 | + activeRequests: UpDownCounter[F, Long] |
| 107 | + ) extends RequestListener[F, State] { |
| 108 | + def beforeRequest(request: GenericRequest[_, _]): F[State] = |
| 109 | + for { |
| 110 | + start <- Clock[F].realTime |
| 111 | + attributes <- Monad[F].pure(activeRequestAttributes(request)) |
| 112 | + _ <- activeRequests.inc(attributes) |
| 113 | + } yield State(start, attributes) |
| 114 | + |
| 115 | + def requestException(request: GenericRequest[_, _], state: State, e: Exception): F[Unit] = |
| 116 | + ResponseException.find(e) match { |
| 117 | + case Some(re) => |
| 118 | + requestSuccessful(request, Response((), re.response.code, request.onlyMetadata), state) |
| 119 | + |
| 120 | + case _ => |
| 121 | + for { |
| 122 | + now <- Clock[F].realTime |
| 123 | + attributes <- Monad[F].pure(fullAttributes(request, None, Some(e.getClass.getName))) |
| 124 | + _ <- requestDuration.record((now - state.start).toUnit(TimeUnit.SECONDS), attributes) |
| 125 | + _ <- request.contentLength.traverse_(size => requestBodySize.record(size, attributes)) |
| 126 | + _ <- activeRequests.dec(state.activeRequestsAttributes) |
| 127 | + } yield () |
| 128 | + } |
| 129 | + |
| 130 | + def requestSuccessful(request: GenericRequest[_, _], response: Response[_], state: State): F[Unit] = |
| 131 | + for { |
| 132 | + now <- Clock[F].realTime |
| 133 | + attributes <- Monad[F].pure(fullAttributes(request, response)) |
| 134 | + _ <- requestDuration.record((now - state.start).toUnit(TimeUnit.SECONDS), attributes) |
| 135 | + _ <- request.contentLength.traverse_(length => requestBodySize.record(length, attributes)) |
| 136 | + _ <- response.contentLength.traverse_(length => responseBodySize.record(length, attributes)) |
| 137 | + _ <- activeRequests.dec(state.activeRequestsAttributes) |
| 138 | + } yield () |
| 139 | + |
| 140 | + private def activeRequestAttributes(request: GenericRequest[_, _]): Attributes = { |
| 141 | + val b = Attributes.newBuilder |
| 142 | + |
| 143 | + b += HttpAttributes.HttpRequestMethod(request.method.method) |
| 144 | + b ++= ServerAttributes.ServerAddress.maybe(request.uri.host) |
| 145 | + b ++= ServerAttributes.ServerPort.maybe(request.uri.port.map(_.toLong)) |
| 146 | + b ++= UrlAttributes.UrlScheme.maybe(request.uri.scheme) |
| 147 | + |
| 148 | + b.result() |
| 149 | + } |
| 150 | + |
| 151 | + private def fullAttributes(request: GenericRequest[_, _], response: Response[_]): Attributes = |
| 152 | + fullAttributes( |
| 153 | + request, |
| 154 | + Some(response.code), |
| 155 | + Option.unless(response.isSuccess)(response.code.toString()) |
| 156 | + ) |
| 157 | + |
| 158 | + private def fullAttributes( |
| 159 | + request: GenericRequest[_, _], |
| 160 | + responseStatusCode: Option[StatusCode], |
| 161 | + errorType: Option[String] |
| 162 | + ): Attributes = { |
| 163 | + val b = Attributes.newBuilder |
| 164 | + |
| 165 | + b += HttpAttributes.HttpRequestMethod(request.method.method) |
| 166 | + b ++= ServerAttributes.ServerAddress.maybe(request.uri.host) |
| 167 | + b ++= ServerAttributes.ServerPort.maybe(request.uri.port.map(_.toLong)) |
| 168 | + b ++= NetworkAttributes.NetworkProtocolVersion.maybe(request.httpVersion.map(networkProtocol)) |
| 169 | + b ++= UrlAttributes.UrlScheme.maybe(request.uri.scheme) |
| 170 | + |
| 171 | + // response |
| 172 | + b ++= HttpAttributes.HttpResponseStatusCode.maybe(responseStatusCode.map(_.code.toLong)) |
| 173 | + b ++= ErrorAttributes.ErrorType.maybe(errorType) |
| 174 | + |
| 175 | + b.result() |
| 176 | + } |
| 177 | + |
| 178 | + private def networkProtocol(httpVersion: HttpVersion): String = |
| 179 | + httpVersion match { |
| 180 | + case HttpVersion.HTTP_1 => "1.0" |
| 181 | + case HttpVersion.HTTP_1_1 => "1.1" |
| 182 | + case HttpVersion.HTTP_2 => "2" |
| 183 | + case HttpVersion.HTTP_3 => "3" |
| 184 | + } |
| 185 | + } |
| 186 | + |
| 187 | +} |
0 commit comments