https://github.com/petitviolet/scala-mlogging
@logging annotation using scala.meta
https://github.com/petitviolet/scala-mlogging
metaprogramming scala scalameta
Last synced: 3 months ago
JSON representation
@logging annotation using scala.meta
- Host: GitHub
- URL: https://github.com/petitviolet/scala-mlogging
- Owner: petitviolet
- Created: 2017-08-20T09:31:12.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-08T12:05:46.000Z (almost 8 years ago)
- Last Synced: 2023-07-05T17:03:57.017Z (over 2 years ago)
- Topics: metaprogramming, scala, scalameta
- Language: Scala
- Size: 25.4 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @logging annotation for tracking method input and output
[](https://maven-badges.herokuapp.com/maven-central/net.petitviolet/mlogging_2.12)
This repository provides a `@logging` annotation.
## @logging annotation
This annotation inserts logging before/after invoking annotated method.
```scala
val logger = new {
def info(s: => String): Unit =
println(s"${LocalDateTime.now()}: $s")
}
// provide your own logger(just a `String => Unit` function)
@logging(logger.info)
def add(i: Int, j: Int): Int = {
i + j
}
println(add(1, 2))
```
Outputs are below.
> 2017-08-19T23:05:26.279: [start]add(1, 2)
> 2017-08-19T23:05:26.308: [end]add(1, 2) => 3
> 3
Also see [samples](https://github.com/petitviolet/scala-mlogging/blob/master/sample/src/main/scala/net/petitviolet/mlogging/meta/loggingApp.scala).
## @timeLogging annotation
This annotation inserts logging before invoking annotated method with elapsed milli seconds.
```scala
val logger = new {
def info(s: => String): Unit =
println(s"${LocalDateTime.now()}: $s")
}
@timeLogging(logger.info)
def add(i: Int, j: Int): Int = {
i + j
}
println(add(1, 2))
@timeLogging(logger.info)
def add2(i: Int)(j: Int)(): Int = {
Thread.sleep(100)
i + j
}
println(add2(2)(3))
```
> 2017-09-07T09:36:26.335: [start]add(1, 2)
> 2017-09-07T09:36:26.400: [end][0 ms]add(1, 2) => 3
> 3
> 2017-09-07T09:36:26.406: [start]add2(2)(3)()
> 2017-09-07T09:36:26.515: [end][107 ms]add2(2)(3)() => 5
> 5
Also see [samples](https://github.com/petitviolet/scala-mlogging/blob/master/sample/src/main/scala/net/petitviolet/mlogging/meta_sample/timeLoggingApp.scala).
## logging options
```scala
case class User(name: String)
@timeLogging(println, Input)
def input(name: String): User = {
Thread.sleep(Random.nextInt(200))
User(name)
}
@timeLogging(println, Output)
def output(name: String): User = {
Thread.sleep(Random.nextInt(200))
User(name)
}
@timeLogging(println, Simple)
def simple(name: String): User = {
Thread.sleep(Random.nextInt(200))
User(name)
}
@timeLogging(println, Full)
def full(name: String): User = {
Thread.sleep(Random.nextInt(200))
User(name)
}
simple("simple")
input("input")
output("output")
full("full")
```
> [start]simple(...)
> [end][41 ms]simple(...) => (...)
> [start]input(input)
> [end][113 ms]input(input) => (...)
> [start]output(...)
> [end][32 ms]output(...) => User(output)
> [start]full(full)
> [end][160 ms]full(full) => User(full)
# setup
in build.sbt
```scala
lazy val metaMacroSettings: Seq[Def.Setting[_]] = Seq(
resolvers += Resolver.sonatypeRepo("releases"),
resolvers += Resolver.bintrayIvyRepo("scalameta", "maven"),
addCompilerPlugin("org.scalameta" % "paradise" % "3.0.0-M9" cross CrossVersion.full),
scalacOptions ++= Seq(
"-Xplugin-require:macroparadise",
// "-Ymacro-debug-lite" // for debug
)
)
project.settings(
metaMacroSettings,
libraryDependencies += "net.petitviolet" %% "mlogging" % ""
)
```
# License
[MIT License](https://petitviolet.mit-license.org/)