Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zio/zio-logging
Powerful logging for ZIO 2.0 applications, with compatibility with many logging backends out-of-the-box.
https://github.com/zio/zio-logging
fp functional-programming logging scala slf4j tracing zio
Last synced: 3 months ago
JSON representation
Powerful logging for ZIO 2.0 applications, with compatibility with many logging backends out-of-the-box.
- Host: GitHub
- URL: https://github.com/zio/zio-logging
- Owner: zio
- License: apache-2.0
- Created: 2019-09-09T14:04:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T10:14:00.000Z (3 months ago)
- Last Synced: 2024-07-31T23:57:40.420Z (3 months ago)
- Topics: fp, functional-programming, logging, scala, slf4j, tracing, zio
- Language: Scala
- Homepage: https://zio.dev/zio-logging/
- Size: 2.37 MB
- Stars: 172
- Watchers: 11
- Forks: 80
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-zio - ZIO Logging - ends (Official ZIO Libraries)
README
[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.)
[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys)
[//]: # (e.g. "readmeDocumentation" and "readmeSupport".)
# zio-logging
[ZIO Logging](https://github.com/zio/zio-logging) is simple logging for ZIO apps, with correlation, context, and pluggable backends out of the box with integrations for common logging backends.
[](https://github.com/zio/zio/wiki/Project-Stages)  [](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-logging_2.13/) [](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-logging_2.13/) [](https://javadoc.io/doc/dev.zio/zio-logging-docs_2.13) [](https://github.com/zio/zio-logging)
## Introduction
When we are writing our applications using ZIO effects, to log easy way we need a ZIO native solution for logging.
Key features of ZIO Logging:
- **ZIO Native** — Other than it is a type-safe and purely functional solution, it leverages ZIO's features.
- **Multi-Platform** - It supports both JVM and JS platforms.
- **Composable** — Loggers are composable together via contraMap.
- **Pluggable Backends** — Support multiple backends like ZIO Console, SLF4j, JPL.
- **Logger Context** — It has a first citizen _Logger Context_ implemented on top of `FiberRef`. The Logger Context maintains information like logger name, filters, correlation id, and so forth across different fibers. It supports _Mapped Diagnostic Context (MDC)_ which manages contextual information across fibers in a concurrent environment.
- Richly integrated into ZIO 2's built-in logging facilities
- ZIO Console, SLF4j, and other backends
## Installation
In order to use this library, we need to add the following line in our `build.sbt` file:
```scala
// ZIO Logging backends
libraryDependencies += "dev.zio" %% "zio-logging" % "2.3.0"
```
The main module contains the following features:
* [console loggers](docs/console-logger.md)
* [file loggers](docs/file-logger.md)
* [log metrics](docs/metrics.md)
Other modules:
* SLF4J backend - if you like to use [`SLF4J`](https://www.slf4j.org/) logging backends (e.g. java.util.logging, logback, log4j), add the one of following lines to your `build.sbt` file:
```scala
// SLF4j v1 integration
libraryDependencies += "dev.zio" %% "zio-logging-slf4j" % "2.3.0"
// SLF4j v2 integration
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2" % "2.3.0"
```
When to use this module: you are already using SLF4J logger in some other project, and you like to have same log outputs.
See SLF4J [v2](docs/slf4j2.md) or [v1](docs/slf4j1.md) section for more details.
* SLF4J bridge - with this logging bridge, it is possible to use `zio-logging` for SLF4J loggers (usually third-party non-ZIO libraries), add the one of following lines to your `build.sbt` file:
```scala
// Using ZIO Logging for SLF4j v1 loggers, usually third-party non-ZIO libraries
libraryDependencies += "dev.zio" %% "zio-logging-slf4j-bridge" % "2.3.0"
// Using ZIO Logging for SLF4j v2 loggers, usually third-party non-ZIO libraries
libraryDependencies += "dev.zio" %% "zio-logging-slf4j2-bridge" % "2.3.0"
```
When to use this module: you want to use some zio-logger implementation, but also you are using some java library which using SLF4J interface for logging.
See SLF4J bridge [v2](docs/slf4j2-bridge.md) or [v1](docs/slf4j1-bridge.md) section for more details.
* Java Platform/System Logger backend - if you like to use [`Java Platform/System Logger`](https://openjdk.org/jeps/264) logging backend, add the following line to your `build.sbt` file:
```scala
// JPL integration
libraryDependencies += "dev.zio" %% "zio-logging-jpl" % "2.3.0"
```
When to use this module: you are already using Java Platform/System Logger in some other project, and you like to have same log outputs.
See [Java Platform/System Logger](docs/jpl.md) section for more details.
* java.util.logging bridge - with this logging bridge, it is possible to use `zio-logging` for JUL loggers (usually third-party non-ZIO libraries), add the one of following lines to your `build.sbt` file:
```scala
// JUL bridge
libraryDependencies += "dev.zio" %% "zio-logging-jul-bridge" % "2.3.0"
```
When to use this module: you are already using JUL logger in some other project, and you like to have same log outputs.
See [java.util.logging bridge](docs/jul-bridge.md) section for more details.
## Example
Let's try an example of ZIO Logging which demonstrates a simple application of ZIO logging.
The recommended place for setting the logger is application boostrap. In this case, custom logger will be set for whole application runtime (also application failures will be logged with specified logger).
[//]: # (TODO: make snippet type-checked using mdoc)
```scala
package zio.logging.example
import zio.logging.consoleLogger
import zio.{ ExitCode, Runtime, Scope, ZIO, ZIOAppArgs, ZIOAppDefault, ZLayer }
object SimpleApp extends ZIOAppDefault {
override val bootstrap: ZLayer[ZIOAppArgs, Any, Any] =
Runtime.removeDefaultLoggers >>> consoleLogger()
override def run: ZIO[Scope, Any, ExitCode] =
for {
_ <- ZIO.logInfo("Start")
_ <- ZIO.fail("FAILURE")
_ <- ZIO.logInfo("Done")
} yield ExitCode.success
}
```
Expected console output:
```
timestamp=2023-03-15T08:36:24.421098+01:00 level=INFO thread=zio-fiber-4 message="Start"
timestamp=2023-03-15T08:36:24.440181+01:00 level=ERROR thread=zio-fiber-0 message="" cause=Exception in thread "zio-fiber-4" java.lang.String: FAILURE
at zio.logging.example.SimpleApp.run(SimpleApp.scala:29)
```
You can find the source code of examples [here](https://github.com/zio/zio-logging/tree/master/examples)
## Documentation
Learn more on the [zio-logging homepage](https://zio.dev/zio-logging)!
## Contributing
For the general guidelines, see ZIO [contributor's guide](https://zio.dev/contributor-guidelines).
## Code of Conduct
See the [Code of Conduct](https://zio.dev/code-of-conduct)
## Support
Come chat with us on [![Badge-Discord]][Link-Discord].
[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
[Link-Discord]: https://discord.gg/2ccFBr4 "Discord"
## License
[License](LICENSE)