[book] Assign number to 1-10 chapters

at15 · at15 · commit 1aece79a534d · 2020-07-28T22:35:35.000+08:00
diff --git a/README.md b/README.md
@@ -1,16 +1,17 @@
 # Notes on Time Series Database
 
-This repo is a work in progress [book](book) about time series database (TSDB) that (will) contains:
+This repo is a work in progress [book](book) and [survey](survey) about time series database (TSDB) that (will) contains:
 
+- Different components of a TSDB, e.g. compression, index etc.
 - [Survey](survey) on [various existing time series databases](https://github.com/xephonhq/awesome-time-series-database)
 - How to write a (distributed) time series database from scratch.
-- Related fields like distributed tracing, OLAP database.
+- Related fields like monitoring, distributed tracing, OLAP database, IOT etc.
 
 Project layout
 
 - [book](book) The WIP book
-- [doc](doc) [Roadmap](doc/ROADMAP.md) and notes on writing notes
 - [survey](survey) Survey on TSDB and related fields
+- [doc](doc) [Roadmap](doc/ROADMAP.md) and notes on writing notes
 
 ## Related
 
@@ -19,11 +20,12 @@ Project layout
 
 ## Acknowledgment
 
-- [Zheyuan Chen](https://github.com/czheo) for his participation in [Xephon-B](https://github.com/xephonhq/xephon-b)
-- Prof. Alvaro for his [distributed system class](https://github.com/palvaro/CMPS232-Fall16)
+- [Zheyuan Chen](https://github.com/czheo) for his work in [Xephon-B](https://github.com/xephonhq/xephon-b)
+- Prof. Alvaro for his [distributed system class](https://github.com/palvaro/CMPS232-Fall16) where the [xephon](https://github.com/xephonhq) project got started.
 
 ## License
 
 The book is licensed under create commons. The sample code (unless specified otherwise in comment) is licensed under MIT.
+Code snippet in survey are licensed under the license of the source project.
 
 [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/us/)
diff --git a/book/03-data-model/README.md b/book/03-data-model/README.md
@@ -0,0 +1,9 @@
+# Chapter 3: Time Series Database Data Model
+
+## TODO
+
+- [ ] list different data models
+  - RRD, Graphite, name + fixed precision
+  - OpenTSDB, KairosDB, Prometheus name + tag
+  - InfluxDB, looks like a columnar database ...
+  - Columnar Database, e.g. Druid
diff --git a/book/04-query-language/README.md b/book/04-query-language/README.md
@@ -0,0 +1,7 @@
+# Chapter 4: Time Series Database Query Language
+
+## TODO
+
+- [ ] promql
+- [ ] influxql, flux
+- [ ] EQL from Elasticsearch
diff --git a/book/05-storage/README.md b/book/05-storage/README.md
@@ -0,0 +1 @@
+# Chapter 5: Time Series Database Storage Engine
diff --git a/book/05-storage/compression/gorilla.md b/book/05-storage/compression/gorilla.md
diff --git a/book/05-storage/index/README.md b/book/05-storage/index/README.md
@@ -0,0 +1,7 @@
+# Index
+
+## TODO
+
+- [ ] two types of index
+  - index on meta data e.g. inverted index for label
+  - index on ts time and/or value, e.g. tree (akumuli, btrdb), aggregated min, max
diff --git a/book/06-benchmark/README.md b/book/06-benchmark/README.md
@@ -0,0 +1 @@
+# Chapter 6: Time Series Database Benchmark
diff --git a/book/07-analysis/README.md b/book/07-analysis/README.md
@@ -1,4 +1,6 @@
-# Chapter 7: Analysis
+# Chapter 6: Analysis
+
+Analysis time series data, e.g. anomaly detection, prediction etc.
 
 ## References
 
diff --git a/book/08-monitoring/README.md b/book/08-monitoring/README.md
@@ -0,0 +1,5 @@
+# Chapter 8: Monitoring
+
+## TODO
+
+- [ ] popular monitoring tools, might put it in survey and mix w/ tsdb ...
diff --git a/book/09-tracing/README.md b/book/09-tracing/README.md
@@ -0,0 +1,5 @@
+# Chapter 9: Distributed Tracing
+
+## TODO
+
+- [ ] distributed tracing standards, storage etc.
diff --git a/book/10-build/README.md b/book/10-build/README.md
@@ -0,0 +1 @@
+# Chapter 10: How to Build a Time Series Database
diff --git a/book/README.md b/book/README.md
@@ -5,50 +5,42 @@ The layout is subject to change, and need to merge w/ libtsdb-go
 - [01 Overview](01-overview)
   - what is time series data and why we need time series database
 - [02 Basic](02-basic)
+  - ? might move it into/before storage chapter
   - [Primitive Types](02-basic/primitive/README.md)
     - [Endianess](02-basic/primitive/endianness.md) How to store larger than one byte value
     - [Integer](02-basic/primitive/integer.md) Unsigned and Signed Integer
     - float number and their machine representation (basic for working on compression)
   - statistic, distribution, random etc.
   - maybe information theory
-? data model ? a dedicated chapter?
-- 03 components (might flatten this)
-  - overview
-  - query language
-    - complex query execution would also be interesting
-    - SQL
-    - continuous query, prometheus ppl also has an article about it
-  - index (in memory and on disk?)
-  - compression
-  - storage
-    - different backend, pros and cons
-  - distribution
-- 04 survey (remove it? or take a small part from the survey folder)
-  - influxdb
-  - prometheus, victoriametrics, thanos (and another one ... forgot the name from weaveworks)
-  - m3db
-  - akumuli, btrdb (both are tree like)
-  - timescaledb (and others on pg, most of them are dead so ...)
-  - druid alike (linkedin also got one)
-  - graphite (and newer backends)
-  - mysql
-  - elasticsearch
-  - crate (it looks pretty good, though it seems it is bought by some other company)
-- 05 benchmark
+- [03 Data Model](03-data-model)
+  - should also contains some basic survey, or link to survey
+- [04 Query Language](04-query-language)
+  - complex query execution would also be interesting
+  - SQL
+  - continuous query, prometheus ppl also has an article about it
+  - ?query execution? a dedicated chapter?
+- [05 Storage](05-storage)
+  - [Compression](05-storage/compression)
+  - [Index](05-storage/index)
+  - local and remote backend (other db, s3 etc.)
+  - distributed
+- [06 Benchmark](06-benchmark)
   - components
     - workload generator
     - stats collector
     - basic math, distribution
     - historgram and lhdr (forgot what's the name ...)
   - existing tools, their pro can cons
-- 06 application
-  - iot
-  - monitoring  
-- 07 analysis (a.k.a ml a.k.a import ts as tf)
+- [07 Analysis](07-analysis) (a.k.a ml a.k.a import ts as tf)
   - prediction
   - anomaly detection
-- 08 tracing (keep it in this repo for now)
+- [08 Monitoring](08-monitoring)
+  - ? include log?
+- [09 Tracing](09-tracing)
+  - (keep it in this repo for now)
+- ? IoT and Logging
 - 09 OLAP, MPP
-- 10 How we (or maybe just me...) built Xephon-K (not yet)
+- [10 Build](10-build) How to Build a Time Series Database
+  - features and components (like how to build relational db/search engine/operating system/programming language etc.)
   - failure injection and correctness validation
   - continuous benchmark
diff --git a/book/query-language/README.md b/book/query-language/README.md
diff --git a/survey/README.md b/survey/README.md
@@ -8,6 +8,18 @@ Databases
 
 - [ ] crates (java)
 - [ ] questdb (java)
+- influxdb
+- prometheus
+  - victoriametrics
+  - thanos (and another one ... forgot the name from weaveworks)
+- m3db
+- akumuli, btrdb (both are tree like)
+- timescaledb (and others on pg, most of them are dead so ...)
+- druid alike (linkedin also got one)
+- graphite (and newer backends)
+- mysql
+- elasticsearch
+- crate (it looks pretty good, though it seems it is bought by some other company)
 
 ## Format
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Chapter 5: Time Series Database Storage Engine`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Chapter 6: Time Series Database Benchmark`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Chapter 10: How to Build a Time Series Database`