influxdb/docs/README.md

InfluxDB IOx Documentation

This directory contains internal design documentation of potential interest for those who wish to understand how the code works. It is not intended to be general user facing documentation

IOx Tech Talks

We hold monthly Tech Talks that explain the project's technical underpinnings. You can register for the InfluxDB IOx Tech Talks here, or you can find links to previous sessions below or in the YouTube playlist:

• December 2020: Rusty Introduction to Apache Arrow recording
• Jan 2021: Data Lifecycle in InfluxDB IOx & How it Uses Object Storage for Persistence recording
• February 2021: Intro to the InfluxDB IOx Read Buffer recording slides
• March 2021: Query Engine Design and the Rust-Based DataFusion in Apache Arrow recording slides
• April 2021: InfluxDB IOx Tech Talks: Replication, Durability and Subscriptions in InfluxDB IOx recording slides
• May 2021: Catalogs - Turning a Set of Parquet Files into a Data Set recording, slides
• June 2021: Performance Profiling in Rust recording, slides
• July 2021: Impacts of Sharding, Partitioning, Encoding & Sorting on Distributed Query Performance recording, slides
• September 2021: Observability of InfluxDB IOx Tracing, Metrics and System Tables recording
• October 2021: Query Processing in InfluxDB IOx recording

Table of Contents:

• Rust style and Idiom guide: style_guide.md
• Distributed Tracing Guide: tracing.md
• Logging Guide: logging.md
• Handling Observability Context: observability.md
• Profiling Guide: profiling.md
• How InfluxDB IOx manages the lifecycle of time series data: data_management.md
• Thoughts on parquet encoding and compression for timeseries data: encoding_thoughts.md
• Thoughts on using multiple cores / thread pools: multi_core_tasks.md
• Query Engine Docs
• Testing documentation for developers of IOx
• Protobuf tips and tricks: Protobuf.
• Catalog Persistence: catalog_persistence.md.
• SQL command line tips and tricks: SQL.
• Notes on server startup and error recovery: server_startup.md
• Notes on the use of local filesystems: local_filesystems.md