Merge pull request #156 from emit-rs/docs/screenshots

Add examples of metric and trace data in zipkin and prometheus

README.md

@@ -6,7 +6,7 @@
 
 ## Developer-first diagnostics for Rust applications
 
-`emit` is a framework for adding diagnostics to your Rust applications with a simple, powerful data model and an expressive syntax inspired by [Message Templates](https://messagetemplates.org). `emit`'s guiding design principle is low ceremony, low cognitive-load.
+`emit` is a framework for adding structured diagnostics to your Rust applications with a simple, powerful data model and an expressive syntax inspired by [Message Templates](https://messagetemplates.org). `emit`'s guiding design principle is low ceremony, low cognitive-load.
 
 This readme covers just enough to give you an idea of what `emit` is. For a proper treatment, see:
 
@@ -52,3 +52,19 @@ fn greet(user: &str) {
 ```
 
 ![The output of running the above program](https://github.com/emit-rs/emit/blob/main/asset/emit_term.png?raw=true)
+
+## Tracing
+
+`emit` can also produce trace data that's compatible with standard tracing tools, like Zipkin.
+
+![An example trace produced by `emit` in Zipkin](https://github.com/emit-rs/emit/blob/main/asset/trace-zipkin.png?raw=true)
+
+See [the guide](https://emit-rs.io/producing-events/tracing.html) for details.
+
+## Metrics
+
+`emit` can also produce metric data that's compatible with standard metric tools, like Prometheus.
+
+![An example metric produced by `emit` in Prometheus](https://github.com/emit-rs/emit/blob/main/asset/metric-prometheus.png?raw=true)
+
+See [the guide](https://emit-rs.io/producing-events/metrics.html) for details.

book/src/producing-events/logging.md

@@ -35,3 +35,9 @@ Event {
 - [`error!`](https://docs.rs/emit/0.11.0-alpha.21/emit/macro.error.html) for errors that caused the calling operation to fail.
 
 See [Levels](./logging/levels.md) for details.
+
+-----
+
+![an example log rendered to the console](../asset/term-err.png)
+
+_An example log produced by `emit` rendered to the console_

book/src/producing-events/logging/properties.md

@@ -46,3 +46,5 @@ Event {
 ```
 
 See [Template syntax and rendering](../../reference/templates.md) for more details.
+
+Properties aren't limited to strings; they can be arbitrarily complex structured values. See [Value data model](../../reference/events.md#value-data-model) for more details.

book/src/producing-events/metrics.md

@@ -35,3 +35,9 @@ Event {
     },
 }
 ```
+
+-----
+
+![an example metric in Prometheus](../asset/metric-prometheus.png)
+
+_An example metric produced by `emit` in Prometheus_

book/src/producing-events/tracing.md

@@ -58,3 +58,9 @@ wait_a_bit(1200).await;
 - [`#[error_span]`](https://docs.rs/emit/0.11.0-alpha.21/emit/attr.error_span.html)
 
 The level of a span may also depend on its execution. See [Fallible functions](./tracing/fallible-functions.md) and [Manual span completion](./tracing/manual-span-completion.md) for details.
+
+-----
+
+![an example trace in Zipkin](../asset/trace-zipkin.png)
+
+_An example trace produced by `emit` in Zipkin_