README
¶
BanyanDB
BanyanDB, as an observability database, aims to ingest, analyze and store Metrics, Tracing and Logging data. It's designed to handle observability data generated by observability platform and APM system, like Apache SkyWalking etc.
Introduction
BanyanDB, as an observability database, aims to ingest, analyze and store Metrics, Tracing, and Logging data. It's designed to handle observability data generated by Apache SkyWalking. Before BanyanDB emerges, the Databases that SkyWalking adopted are not ideal for the APM data model, especially for saving tracing and logging data. Consequently, There’s room to improve the performance and resource usage based on the nature of SkyWalking data patterns.
The database research community usually uses RUM conjecture to describe how a database access data. BanyanDB combines several access methods to build a comprehensive APM database to balance read cost, update cost, and memory overhead.
Documents
RoadMap
Client manager
- gRPC server
- HTTP server
Distributed manager (v1.0.0)
- Sharding
- Replication and consistency model
- Load balance
- Distributed query optimizer
- Node discovery
- Data queue
Data processor
- Schema management
- Time-series abstract layer
- Stream data processor
- Measure data processor
- Property data processor
- TopNAggregation processor
- Index processor
- TTL
- Cold data processor
- WAL (v0.3.0)
Query processor
- Stream query processor
- Measure query processor
- Index reader
- Streaming pipeline processor(OR and nested querying)
- Parallel executor
- Cost-based optimizer
Verification
- E2E with OAP and simulated data
- E2E with showcases, agents and OAP (v0.3.0)
- Space utilization rate
- Leading and trailing zero (v0.4.0)
- Stability (v0.3.0)
- Crash recovery (v0.3.0)
- Performance
Tools
- Command-line
- Webapp (v0.4.0)
Contributing
For developers who want to contribute to this project, see the Contribution Guide](CONTRIBUTING.md)
License
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
cmd/server
command
|
|
|
internal/cmd
Package cmd is an internal package defining cli commands for BanyanDB
|
Package cmd is an internal package defining cli commands for BanyanDB |
|
observability
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
tsdb
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
tsdb/bucket
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
bydbctl
|
|
|
cmd/bydbctl
command
Package main provides main entry for the command-line toolkit, i.e.
|
Package main provides main entry for the command-line toolkit, i.e. |
|
internal/cmd
Package cmd is an internal package defining cli commands for bydbctl
|
Package cmd is an internal package defining cli commands for bydbctl |
|
pkg/file
Package file provides utils to handle files
|
Package file provides utils to handle files |
|
pkg
|
|
|
grpchelper
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
query/logical/measure
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
test
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
test/flags
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
test/helpers
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
timestamp
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements.
|
Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. |
|
version
Package version can be used to implement embedding versioning details from git branches and tags into the binary importing this package.
|
Package version can be used to implement embedding versioning details from git branches and tags into the binary importing this package. |
|
test
|
|
|
cases/measure
Package measure_test contains integration test cases of the measure
|
Package measure_test contains integration test cases of the measure |
|
cases/measure/data
Package data contains integration test cases of the measure
|
Package data contains integration test cases of the measure |
|
cases/stream
Package stream_test contains integration test cases of the stream
|
Package stream_test contains integration test cases of the stream |
|
cases/stream/data
Package data contains integration test cases of the stream
|
Package data contains integration test cases of the stream |
|
cases/topn
Package topn_test contains integration test cases of the TopN
|
Package topn_test contains integration test cases of the TopN |
|
cases/topn/data
Package data contains integration test cases of the topN
|
Package data contains integration test cases of the topN |
|
e2e-v2/cases/profiling/ebpf
command
Package main generates system load
|
Package main generates system load |
Click to show internal directories.
Click to hide internal directories.