Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
influxdb/docs/README.md

53 lines
4.2 KiB
Markdown
Raw Normal View History

docs: Add reference to docs directory and a table of contents (#577)
2020-12-18 17:39:38 +00:00
# InfluxDB IOx Documentation
docs: Clean up docs (#4764) * docs: Remove outdated instructions for running OG * docs: clarify docs / readme Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-06-03 14:21:14 +00:00
Please see the main [README](../README.md) for user facing documentation.
docs: Add reference to docs directory and a table of contents (#577)
2020-12-18 17:39:38 +00:00
This directory contains internal design documentation of potential
docs: Clean up docs (#4764) * docs: Remove outdated instructions for running OG * docs: clarify docs / readme Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-06-03 14:21:14 +00:00
interest for those who wish to understand how the code works.
docs: Add reference to docs directory and a table of contents (#577)
2020-12-18 17:39:38 +00:00
docs: Add links to tech talks
2021-03-12 19:35:16 +00:00
## IOx Tech Talks
docs: Add tech talk links to docs (#2858) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-10-15 21:44:41 +00:00
We hold monthly Tech Talks that explain the project's technical underpinnings. You can register for the [InfluxDB IOx Tech Talks here](https://www.influxdata.com/community-showcase/influxdb-tech-talks/), or you can find links to previous sessions below or in the [YouTube playlist](https://www.youtube.com/playlist?list=PLYt2jfZorkDp-PKBS05kf2Yx2NrRyPAAz):
docs: Add links to tech talks
2021-03-12 19:35:16 +00:00
* December 2020: Rusty Introduction to Apache Arrow [recording](https://www.youtube.com/watch?v=dQFjKa9vKhM)
* Jan 2021: Data Lifecycle in InfluxDB IOx & How it Uses Object Storage for Persistence [recording](https://www.youtube.com/watch?v=KwdPifHC1Gc)
* February 2021: Intro to the InfluxDB IOx Read Buffer [recording](https://www.youtube.com/watch?v=KslD31VNqPU) [slides](https://www.slideshare.net/influxdata/influxdb-iox-tech-talks-intro-to-the-influxdb-iox-read-buffer-a-readoptimized-inmemory-query-execution-engine)
fix: space
2021-03-12 19:36:17 +00:00
* March 2021: Query Engine Design and the Rust-Based DataFusion in Apache Arrow [recording](https://www.youtube.com/watch?v=K6eCAVEk4kU) [slides](https://www.slideshare.net/influxdata/influxdb-iox-tech-talks-query-engine-design-and-the-rustbased-datafusion-in-apache-arrow-244161934)
docs: Add links to latest tech talks (#2013) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-07-15 13:10:49 +00:00
* April 2021: InfluxDB IOx Tech Talks: Replication, Durability and Subscriptions in InfluxDB IOx [recording](https://www.youtube.com/watch?v=UQj8ZaH5Yi4) [slides](https://www.slideshare.net/influxdata/influxdb-iox-tech-talks-replication-durability-and-subscriptions-in-influxdb-iox)
* May 2021: Catalogs - Turning a Set of Parquet Files into a Data Set [recording](https://www.youtube.com/watch?v=Zaei3l3qk0c), [slides](https://www.slideshare.net/influxdata/catalogs-turning-a-set-of-parquet-files-into-a-data-set)
* June 2021: Performance Profiling in Rust [recording](https://www.youtube.com/watch?v=_ZNcg-nAVTM), [slides](https://www.slideshare.net/influxdata/performance-profiling-in-rust)
* July 2021: Impacts of Sharding, Partitioning, Encoding & Sorting on Distributed Query Performance [recording](https://www.youtube.com/watch?v=VHYMpItvBZQ), [slides](https://www.slideshare.net/influxdata/impacts-of-sharding-partitioning-encoding-and-sorting-on-distributed-query-performance)
docs: update tech talks
2021-12-10 21:07:45 +00:00
* September 2021: Observability of InfluxDB IOx Tracing, Metrics and System Tables [recording](https://www.youtube.com/watch?v=tB-umdJCJQc), [slides](https://www.slideshare.net/influxdata/observability-of-influxdb-iox-tracing-metrics-and-system-tables)
* October 2021: Query Processing in InfluxDB IOx [recording](https://www.youtube.com/watch?v=9DYkWuM8xco), [slides](https://www.slideshare.net/influxdata/influxdb-iox-tech-talks-query-processing-in-influxdb-iox)
* November 2021: The Impossible Dream: Easy-to-Use, Super Fast Software and Simple Implementation [recording](https://www.youtube.com/watch?v=kK_7t24dQ-Q&list=PLYt2jfZorkDp-PKBS05kf2Yx2NrRyPAAz&index=2&t=122s), [slides](https://www.slideshare.net/influxdata/influxdb-iox-tech-talks-the-impossible-dream-easytouse-super-fast-software-and-simple-implementation)
docs: Add links to latest tech talks (#2013) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-07-15 13:10:49 +00:00
docs: Add links to tech talks
2021-03-12 19:35:16 +00:00
docs: Add reference to docs directory and a table of contents (#577)
2020-12-18 17:39:38 +00:00
## Table of Contents:
feat: Consolidate all bucket config into one option/env var Fixes #869.
2021-02-24 21:52:18 +00:00
docs: Add docs for CLI (#4559) * docs: Add docs for CLI * fix: add todo * fix: Update docs/cli.md Co-authored-by: Nga Tran <nga-tran@live.com> Co-authored-by: Nga Tran <nga-tran@live.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-05-11 15:51:34 +00:00
### User Contents
* [SQL command line tips and tricks](sql.md)
* [CLI command line tips and tricks](cli.md)
### Developer Content
feat: Remove outdated OG docs (#4507) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-05-02 22:03:15 +00:00
* [Rust style and Idiom guide](style_guide.md)
* [Distributed Tracing Guide](tracing.md)
* [Logging Guide](logging.md)
* [Handling Observability Context](observability.md)
* [Metrics guide](metrics.md)
* [Profiling Guide](profiling.md)
* [Valgrind Guide](valgrind.md)
* [Protobuf tips and tricks](protobuf.md)
fix: remove a dot
2021-12-14 06:08:54 +00:00
* [Testing documentation](testing.md) for developers of IOx
docs: link docs
2021-12-14 06:06:06 +00:00
* IOx Architecture
feat: Remove outdated OG docs (#4507) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-05-02 22:03:15 +00:00
* [Data Deduplication & Sort Key](dedup_and_sort.md)
* Transactions and locks (to be written & linked)
* [Thoughts on using multiple cores / thread pools](multi_core_tasks.md)
docs: data retention (#6245) * docs: data retention * docs: address review comments Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-11-29 15:34:23 +00:00
* [Compactor](compactor.md)
* [Data Rentention Policy](retention_policy.md)
ci: fix cargo deny (#4629) * ci: fix cargo deny * chore: downgrade `socket2`, version 0.4.5 was yanked * chore: rename `query` to `iox_query` `query` is already taken on crates.io and yanked and I am getting tired of working around that.
2022-05-18 09:38:35 +00:00
* [Query Engine Docs](../iox_query/README.md)
feat: Remove outdated OG docs (#4507) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-05-02 22:03:15 +00:00
* [Notes on the use of local filesystems](local_filesystems.md)
refactor: use new ingester<>querier wire protocol (#4867) * refactor: use new ingester<>querier wire protocol Use and document the new and more flexible ingester<>querier wire protocol. Note that the ingester does NOT stream the response data yet, but the internal data structures would allow that. A follow-up change will adjust the ingester code to stream the data. Ref #4849. * fix: typos Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org> * refactor: clarify naming and public interface * test: add schema assertion to `ingester_response_to_record_batches` Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
2022-06-16 08:02:28 +00:00
* [Querier <> Ingester Query Protocol](ingester_querier_protocol.md)
docs: Add guide for running / profiling IOx locally (#5057) * docs: Add guide for running / profiling IOx locally * fix: Apply suggestions from code review Co-authored-by: Carol (Nichols || Goulding) <193874+carols10cents@users.noreply.github.com> * docs: Add note about why it is an "underground" guide * docs: add note about running locally, and move catalog prodding after * docs: add INFLUXDB_IOX_MAX_HTTP_REQUEST_SIZE and clarify settings Co-authored-by: Carol (Nichols || Goulding) <193874+carols10cents@users.noreply.github.com>
2022-07-11 13:20:58 +00:00
* [Underground Guide to Running IOx Locally](underground_guide.md)