Skip to content

Commit f296b7c

Browse files
committed
Update readme
1 parent 870ec21 commit f296b7c

File tree

4 files changed

+21
-13
lines changed

4 files changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![license-mit](https://img.shields.io/badge/license-MIT-yellow.svg)](./LICENSE)
66
[![dependency status](https://deps.rs/repo/github/duo-rs/duo/status.svg)](https://deps.rs/repo/github/duo-rs/duo)
77

8-
**Observability duo: Logging and Tracing.**
8+
**A lightweight Logging and Tracing observability solution for Rust, built with [Apache Arrow](https://arrow.apache.org), [Apache Parquet](https://parquet.apache.org) and [Apache DataFusion](https://datafusion.apache.org).**
99

1010
> **Notice: this project is in the experimental stage and not production-ready. Use at your own risk.**
1111
@@ -17,19 +17,9 @@ This project was inspired by [tracing](https://github.com/tokio-rs/tracing) and
1717

1818
- **duo-api** - a wire protocol for logging and tracing data. The wire format is defined using gRPC and protocol buffers.
1919
- **duo-subscriber** - instrumentation for collecting logging and tracing data from a process and exposing it over the wire format. `duo-subscriber` crate in this repository contains an implementation of the instrumentation-side API as a [tracing-subscriber](https://crates.io/crates/tracing-subscriber) [Layer](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/layer/trait.Layer.html), for projects using Tokio and tracing.
20-
- **duo-ui** - the web UI for duo. Currently, we just use the [jaeger-ui](https://github.com/jaegertracing/jaeger-ui) for tracing and have no UI for logging. The future repository is here: [duo-rs/duo-ui](https://github.com/duo-rs/duo-ui).
20+
- **duo-ui** - the web UI for duo.
2121
- **duo-server** - the aggregating server to collect tracing and logging data and interact with duo web UI.
2222

23-
## Why called duo?
24-
25-
Duo is mainly a musical terminology meaning a musical composition for two performers in which the performers have equal importance to the piece, often a composition involving two singers or two pianists.
26-
27-
The famous duo band is [Brooklyn Duo](https://www.youtube.com/c/BrooklynDuo), you can visit this video ([Canon in D (Pachelbel's Canon) - Cello & Piano](https://www.youtube.com/watch?v=Ptk_1Dc2iPY)) to learn more about them.
28-
29-
![](https://i.ytimg.com/vi/Ptk_1Dc2iPY/maxresdefault.jpg)
30-
31-
I personally think the logging and tracing have equal importance to observability, they are just like a duo band to help you diagnose your application.
32-
3323
## Get started
3424

3525
### Installation
@@ -78,7 +68,15 @@ async fn main() {
7868
7969
Run your application then check the http://127.0.0.1:3000 to see the tracing data.
8070

81-
![](./duo-ui.png)
71+
### Logging UI
72+
73+
![](./duo-ui-logging.png)
74+
75+
### Tracing UI
76+
77+
Currently trace view is based on [Jaeger UI](https://www.jaegertracing.io), we'll rewrite it with Svelte in the future.
78+
79+
![](./duo-ui-tracing.png)
8280

8381
## Roadmap
8482

@@ -98,6 +96,16 @@ Run your application then check the http://127.0.0.1:3000 to see the tracing dat
9896

9997
- [ ] Support OpenTelemetry specification, aimed to be a lightweight OpenTelemetry backend.
10098

99+
## Why called duo?
100+
101+
Duo is mainly a musical terminology meaning a musical composition for two performers in which the performers have equal importance to the piece, often a composition involving two singers or two pianists.
102+
103+
The famous duo band is [Brooklyn Duo](https://www.youtube.com/c/BrooklynDuo), you can visit this video ([Canon in D (Pachelbel's Canon) - Cello & Piano](https://www.youtube.com/watch?v=Ptk_1Dc2iPY)) to learn more about them.
104+
105+
![](https://i.ytimg.com/vi/Ptk_1Dc2iPY/maxresdefault.jpg)
106+
107+
I personally think the logging and tracing have equal importance to observability, they are just like a duo band to help you diagnose your application.
108+
101109
## License
102110

103111
This project is licensed under the [MIT license](./LICENSE).

duo-ui-logging.png

213 KB
Loading

duo-ui-tracing.png

146 KB
Loading

duo-ui.png

-167 KB
Binary file not shown.

0 commit comments

Comments
 (0)