Skip to content

Add ability to create sttp4 StreamBackend metrics backend #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BrainHorse wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add ability to create sttp4 StreamBackend metrics backend #389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 62 additions & 21 deletions modules/sttp4/src/main/scala/sttp/client4/smetrics/SmetricsBackend.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,33 @@ object SmetricsBackend {
)
}

def apply[F[_]: Clock: Monad: ToTry, C](
delegate: StreamBackend[F, C],
durationMapper: GenericRequest[?, ?] => Option[Histogram[F]],
activeMapper: GenericRequest[?, ?] => Option[Gauge[F]],
successMapper: (GenericRequest[?, ?], ResponseMetadata) => Option[Counter[F]],
errorMapper: (GenericRequest[?, ?], ResponseMetadata) => Option[Counter[F]],
failureMapper: (GenericRequest[?, ?], Throwable) => Option[Counter[F]],
requestSizeMapper: GenericRequest[?, ?] => Option[Summary[F]],
responseSizeMapper: (GenericRequest[?, ?], ResponseMetadata) => Option[Summary[F]],
): StreamBackend[F, C] = {
// redirects should be handled before metrics collection
FollowRedirectsBackend(
ListenerBackend(
delegate = delegate,
listener = new SmetricsListener[F](
durationMapper = durationMapper,
activeMapper = activeMapper,
successMapper = successMapper,
errorMapper = errorMapper,
failureMapper = failureMapper,
requestSizeMapper = requestSizeMapper,
responseSizeMapper = responseSizeMapper,
),
),
)
}

/**
* Creates an STTP backend with automatic metric collection using a CollectorRegistry.
*
Expand Down Expand Up @@ -306,13 +333,35 @@ object SmetricsBackend {
prefix: Option[String] = None,
): Resource[F, Backend[F]] = {
val registry = prefix.fold(collectorRegistry)(collectorRegistry.prefixed(_))
makeDefault(delegate, registry)
makeDefaultSmetricsListener(registry).map { listener =>
FollowRedirectsBackend(
ListenerBackend(
delegate,
listener,
),
)
}
}

private def makeDefault[F[_]: Clock: Monad: ToTry](
delegate: Backend[F],
def default[F[_]: Clock: Monad: ToTry, C](
delegate: StreamBackend[F, C],
collectorRegistry: CollectorRegistry[F],
prefix: Option[String],
): Resource[F, StreamBackend[F, C]] = {
val registry = prefix.fold(collectorRegistry)(collectorRegistry.prefixed(_))
makeDefaultSmetricsListener(registry).map { listener =>
FollowRedirectsBackend(
ListenerBackend(
delegate,
listener,
),
)
}
}

private def makeDefaultSmetricsListener[F[_]: Clock: Monad: ToTry](
collectorRegistry: CollectorRegistry[F],
): Resource[F, Backend[F]] =
): Resource[F, SmetricsListener[F]] =
for {
duration <- collectorRegistry.histogram(
name = MetricNames.duration,
Expand Down Expand Up @@ -352,23 +401,15 @@ object SmetricsBackend {
labels = LabelNames("method", "status"),
quantiles = Quantiles.Default,
)
} yield {
// redirects should be handled before metrics collection
FollowRedirectsBackend(
ListenerBackend(
delegate,
new SmetricsListener[F](
durationMapper = { req => duration.labels(methodLabel(req)).some },
activeMapper = { req => active.labels(methodLabel(req)).some },
successMapper = { (req, rsp) => success.labels(methodLabel(req), statusLabel(rsp)).some },
errorMapper = { (req, rsp) => error.labels(methodLabel(req), statusLabel(rsp)).some },
failureMapper = { (req, _) => failure.labels(methodLabel(req)).some },
requestSizeMapper = { req => requestSize.labels(methodLabel(req)).some },
responseSizeMapper = { (req, rsp) => responseSize.labels(methodLabel(req), statusLabel(rsp)).some },
),
),
)
}
} yield new SmetricsListener[F](
durationMapper = { req => duration.labels(methodLabel(req)).some },
activeMapper = { req => active.labels(methodLabel(req)).some },
successMapper = { (req, rsp) => success.labels(methodLabel(req), statusLabel(rsp)).some },
errorMapper = { (req, rsp) => error.labels(methodLabel(req), statusLabel(rsp)).some },
failureMapper = { (req, _) => failure.labels(methodLabel(req)).some },
requestSizeMapper = { req => requestSize.labels(methodLabel(req)).some },
responseSizeMapper = { (req, rsp) => responseSize.labels(methodLabel(req), statusLabel(rsp)).some },
)

/**
* Internal state passed between request lifecycle hooks.
Expand Down