Add observability documentation

fremantle-industries · Mar 17, 2021 · 35b1d36 · 35b1d36
1 parent 1ee35c4
commit 35b1d36
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 A composable, real time, market data and trade execution toolkit. Built with [Elixir](https://elixir-lang.org/), runs on the [Erlang virtual machine](http://erlang.org/faq/implementations.html)
 
-[Built with Tai](./docs/BUILT_WITH_TAI.md) | [Install](#install) | [Usage](#usage) | [Commands](./docs/COMMANDS.md) | [Architecture](./docs/ARCHITECTURE.md) | [Examples](./apps/examples) | [Configuration](./docs/CONFIGURATION.md)
+[Built with Tai](./docs/BUILT_WITH_TAI.md) | [Install](#install) | [Usage](#usage) | [Commands](./docs/COMMANDS.md) | [Architecture](./docs/ARCHITECTURE.md) | [Examples](./apps/examples) | [Configuration](./docs/CONFIGURATION.md) | [Observability](./docs/OBSERVABILITY.md)
 
 ## What Can I Do? TLDR;
 

diff --git a/apps/examples/README.md b/apps/examples/README.md
@@ -1,6 +1,8 @@
 # Examples
 
-[Built with Tai](../../docs/BUILT_WITH_TAI.md) | [Install](../../README.md#install) | [Usage](../../README.md#usage) | [Commands](../../docs/COMMANDS.md) | [Architecture](../../docs/ARCHITECTURE.md) | [Examples](./README.md) | [Configuration](../../docs/CONFIGURATION.md)
+[Built with Tai](../../docs/BUILT_WITH_TAI.md) | [Install](../../README.md#install) | [Usage](../../README.md#usage) | [Commands](../../docs/COMMANDS.md) | [Architecture](../../docs/ARCHITECTURE.md) | [Examples](./README.md) | [Configuration](../../docs/CONFIGURATION.md) | [Observability](../../docs/OBSERVABILITY.md)
+
+
 
 ### [Log the spread of every order book](./lib/examples/log_spread)
 

diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md
@@ -1,6 +1,6 @@
 # Architecture
 
-[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md)
+[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md) | [Observability](./OBSERVABILITY.md)
 
 ## Advisors
 

diff --git a/docs/BUILT_WITH_TAI.md b/docs/BUILT_WITH_TAI.md
@@ -1,6 +1,7 @@
 # Built with Tai
 
-[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md)
+[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md) | [Observability](./OBSERVABILITY.md)
+
 
 ## [Workbench](https://github.com/fremantle-industries/workbench)
 

diff --git a/docs/COMMANDS.md b/docs/COMMANDS.md
@@ -1,6 +1,7 @@
 # Commands
 
-[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md)
+[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md) | [Observability](./OBSERVABILITY.md)
+
 
 To monitor your instance, `tai` provides the following set of IEx commands.
 

diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -1,6 +1,7 @@
 # Configuration
 
-[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md)
+[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md) | [Observability](./OBSERVABILITY.md)
+
 
 To quickly get started, take a look at the [example dev configuration](../config/dev.exs.example) for some available options.
 

diff --git a/docs/OBSERVABILITY.md b/docs/OBSERVABILITY.md
@@ -0,0 +1,14 @@
+# Observability
+
+[Built with Tai](./BUILT_WITH_TAI.md) | [Install](../README.md#install) | [Usage](../README.md#usage) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md)
+
+Using the power of the wonderful [telemetry](https://elixirschool.com/blog/instrumenting-phoenix-with-telemetry-part-one/)
+library `tai` emits metrics that can be used to visualize and alert on the
+inner workings of your trading systems.
+
+```elixir
+# streams
+[:tai, :venues, :stream, :connect]
+[:tai, :venues, :stream, :disconnect]
+[:tai, :venues, :stream, :terminate]
+```