profunktor / http4s-tracer Goto Github PK

View Code? Open in Web Editor NEW

109.0 3.0 13.0 1.68 MB

:bar_chart: End-to-end tracing system for Http4s

Home Page: https://http4s-tracer.profunktor.dev/

License: Apache License 2.0

Scala 83.79% CSS 1.58% JavaScript 12.78% HTML 0.69% Nix 1.17%

http4s middleware reader-monad kleisli tracer tracing-applications

http4s-tracer's Introduction

http4s-tracer

End-to-end tracing system for http4s.

Dependencies

Add this to your build.sbt:

libraryDependencies += "dev.profunktor" %% "http4s-tracer" % Version

If you would like to have log4cats support add this extra dependency:

libraryDependencies += "dev.profunktor" %% "http4s-tracer-log4cats" % Version

Note: previous versions <= 1.2.1 were published using the com.github.gvolpe group id (see migration guide).

Find out more in the microsite.

Code of Conduct

See the Code of Conduct

LICENSE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project 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.

http4s-tracer's People

Contributors

Stargazers

Watchers

Forkers

kkrs scala-steward sullis elyasib pierangeloc d2a4u jcranky asachdeva slivkamiro eternalerrors alexbalonperin manelp jacke

http4s-tracer's Issues

Use mdoc for the microsite

tut is no longer maintained and has issues with new versions of sbt-microsites.

Consider making `TraceId` the user responsiblity

Problem

Right now we have type Trace[F[_], A] = Kleisli[F, TraceId, A] but that constraints the usage of Kleisli to just carry a TraceId and we are limiting what the user can do.

Ideally, we should be able to carry more context as recommended in the ReaderT design pattern article.

Proposal

Replace TraceId parameter in Kleisli for an interface that carries the TraceId:

trait TraceContext {
  def traceId: TraceId
}

Now the user might be able to say:

class UserContext extends TraceContext {
  val config: Config = ???
  def traceId: TraceId = ???
}

Still not completely sure whether this would work or not but worth investigating.