<div align="center">

# tracing-surreal

English | [简体中文](README-CN.md)

(WIP) A tracing [Layer](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/layer/trait.Layer.html) that can forward all tracing data to [SurrealDB](https://surrealdb.com/) 🚧

[Website](https://opensound.run) | [crates.io](https://crates.io/crates/tracing-surreal) | [docs.rs](https://docs.rs/tracing-surreal/latest/tracing-surreal)

Original Author: [@czy-29](https://github.com/czy-29)

Latest version: [v0.0.1](https://github.com/opensound-org/tracing-surreal/releases/tag/v0.0.1)

![Crates.io Total Downloads](https://img.shields.io/crates/d/tracing-surreal)
[![Crates.io Dependents](https://img.shields.io/crates/dependents/tracing-surreal)](https://crates.io/crates/tracing-surreal/reverse_dependencies)
![GitHub Repo stars](https://img.shields.io/github/stars/opensound-org/tracing-surreal)

![MSRV (version)](https://img.shields.io/crates/msrv/tracing-surreal/0.0.1?label=v0.0.1-msrv)
[![dependency status (version)](https://deps.rs/crate/tracing-surreal/0.0.1/status.svg?subject=v0.0.1-deps)](https://deps.rs/crate/tracing-surreal/0.0.1)

![MSRV (git)](https://img.shields.io/badge/git--msrv-1.80.0-blue)
[![dependency status (git)](https://deps.rs/repo/github/opensound-org/tracing-surreal/status.svg?subject=git-deps)](https://deps.rs/repo/github/opensound-org/tracing-surreal)

[![Static Badge](https://img.shields.io/badge/build_with-Rust_1.82.0-dca282)](https://blog.rust-lang.org/2024/10/17/Rust-1.82.0.html)

</div>

## What
🚧 (WIP) A tracing [Layer](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/layer/trait.Layer.html) that can forward all tracing data to [SurrealDB](https://surrealdb.com/).

## Why
🚧 (Under construction...)

## How
🚧 (Under construction...)

# License

This project is licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
   http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
   http://opensource.org/licenses/MIT)

at your option.

## Contribution

[Github](https://github.com/opensound-org/tracing-surreal) is our [single source of truth](https://en.wikipedia.org/wiki/Single_source_of_truth), where we welcome all issues and pull requests.

We also have two downstream read-only mirrors that are [automatically pushed](.github/workflows/mirror.yml):
- [GitLab](https://gitlab.com/opensound-org/tracing-surreal)
- [Gitee](https://gitee.com/opensound-org/tracing-surreal)

As they are read-only mirrors, please do not initiate any merge or pull requests on these two platforms.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `tracing-surreal` by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.