Skip to content

api-evangelist/apache-bookkeeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Apache BookKeeper (apache-bookkeeper)

Apache BookKeeper is a scalable, fault-tolerant, and low-latency storage service optimized for real-time workloads developed by the Apache Software Foundation. It provides a simple log-oriented storage abstraction called ledgers for reliable, replicated storage of sequential data. BookKeeper is used as the durable log storage layer in Apache Pulsar and other distributed messaging and stream processing systems. It provides a Java client API and an HTTP Admin REST API for cluster management, bookie monitoring, and auto-recovery operations.

URL: https://bookkeeper.apache.org/

Run: Capabilities Using Naftiko

Tags

  • Apache, Distributed Systems, Log Storage, Open Source, Storage, Streaming

Timestamps

  • Created: 2026-03-16
  • Modified: 2026-04-19

APIs

Apache BookKeeper Admin API

The Apache BookKeeper HTTP Admin API provides REST endpoints for managing and monitoring BookKeeper clusters, bookies, ledgers, and auto-recovery operations. It enables programmatic cluster administration, ledger inspection, bookie health monitoring, and garbage collection management.

Human URL: https://bookkeeper.apache.org/docs/admin/http

Tags

  • Administration, Cluster Management, Monitoring

Properties

Apache BookKeeper Java Client API

The BookKeeper Java client API provides programmatic access for creating, writing, reading, and managing ledgers. It supports both the legacy LedgerHandle API and the newer Ledger API with explicit durability guarantees.

Human URL: https://bookkeeper.apache.org/docs/api/ledger-api

Tags

  • Java, Ledger, Storage

Properties

Common Properties

Features

Name Description
Ledger Storage Append-only log segments called ledgers provide the foundational storage primitive for reliable sequential data storage.
Ensemble Replication Data is written to a configurable ensemble of bookies with write quorum and ack quorum parameters for fault tolerance.
Auto-Recovery Built-in under-replication detection and automatic ledger re-replication when bookie nodes fail.
HTTP Admin API RESTful HTTP Admin API for managing ledgers, bookies, cluster configuration, and triggering recovery operations.
Metrics Export Prometheus-format metrics endpoint for monitoring bookie performance and storage utilization.
Auditor Election ZooKeeper-based leader election for the auditor role responsible for detecting under-replicated ledgers.
Garbage Collection Configurable garbage collection for reclaiming storage from deleted or expired ledger data.
Journal and Ledger Storage Separate journal and ledger storage paths optimized for sequential write throughput and random read performance.

Use Cases

Name Description
Durable Log Storage Serve as the replicated, durable write-ahead log for Apache Pulsar topics and distributed streaming systems.
Distributed Transaction Logs Store distributed transaction log segments for systems requiring exactly-once semantics and durable commit records.
Metadata Store Persist metadata and configuration data for distributed systems requiring consistent, replicated storage.
Stream Processing Storage Provide low-latency, high-throughput sequential storage for real-time stream processing pipelines.
Cluster Administration Monitor and manage BookKeeper clusters using the HTTP Admin API for operational visibility and recovery.

Integrations

Name Description
Apache Pulsar BookKeeper serves as the durable log storage layer for Apache Pulsar messaging topics.
Apache ZooKeeper ZooKeeper is used for bookie coordination, auditor election, and cluster metadata management.
Apache Hadoop BookKeeper can be used with Hadoop ecosystem tools for reliable log storage alongside HDFS.
Prometheus BookKeeper exports Prometheus-format metrics for cluster monitoring and alerting.
Grafana Grafana dashboards consume BookKeeper Prometheus metrics for operational visibility.

Artifacts

Machine-readable API specifications organized by format.

OpenAPI

JSON Schema

9 schema files covering LedgerList, LedgerMetadata, LedgerEntries, BookieInfo, BookieList, ClusterInfo, BookieState, GcStatus, and AuditorInfo.

JSON-LD

Capabilities

Naftiko capabilities organized as shared per-API definitions composed into customer-facing workflows.

Shared Per-API Definitions

Workflow Capabilities

Workflow APIs Combined Tools Persona
Apache BookKeeper Cluster Management Admin API 6 Cluster Administrator, Storage Engineer

Vocabulary

  • Apache BookKeeper Vocabulary — Domain taxonomy mapping 7 resources, 5 actions, 1 workflow, and 2 personas for cluster management and ledger operations

Rules

Maintainers

FN: Kin Lane

Email: info@apievangelist.com

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors