Skip to content

Repository files navigation

Backbone Kit

Lines of Code Top Language Languages Code to Comment License Last Commit

Quarkus Conventional Commits Commitizen friendly

CI Status

00 🧩 Hygiene checks 01 🚧 Build and test 02 🔎 Static analysis
03 👊🏽 Auto version bump 04 📦 Publish packages 51 🔎 Code coverage

codecov


Overview

Backbone Kit is a collection of infrastructure components that support 👉 Backbone.

It provides Quarkus-based components for security, observability, and cross-cutting service concerns — without prescribing domain logic.

Backbone Kit demonstrates the following capabilities that continue with the full Backbone Platform:

  • architectural composure and separation of concerns
  • implementation of microservice cross-cutting concerns
  • disciplined coding standards, documentation, and test organisation

What Backbone Kit Provides

🔒 Security & Protection

  • Rate Limiting & Throttling (backbone-throttle)
    • Deterministic rate limiting with clear separation of authenticated vs. unauthenticated capacity.
    • Documentation →

📈 Observability

  • Metrics Framework (backbone-metrics)

    • Micrometer integration with Prometheus-ready metrics.
    • Service, circuit breaker, and database performance recorders
    • Documentation →
  • Prometheus Remote Write (backbone-observability-api, backbone-observability-aws)

    • PRW 1.0 encoding from Micrometer MetricSnapshots (no text scrape parsing).
    • Scheduled push to Amazon Managed Prometheus with SigV4-signed remote write.
    • Profile-gated via @LookupIfProperty — enable only where AMP is configured.
    • Documentation →
  • Distributed Tracing (AWS) (backbone-observability-aws)

    • OTLP protobuf export to AWS X-Ray with SigV4 signing.
    • Works with Quarkus OpenTelemetry; no collector sidecar required.
    • Documentation →
  • AWS Signed HTTP Transport (backbone-http-aws)

    • Reusable SigV4 signing for outbound HTTP (AMP, X-Ray OTLP, and other AWS endpoints).
    • Documentation →
  • Health Checks (backbone-health-aws)

  • Structured Logging (backbone-logging)

    • Opt-in method entry logging via @LogMethodEntry.
    • HTTP correlation ID propagation (MDC and headers).
    • Sensitive data masking in log output.
    • Documentation →

🧱 Platform Utilities

  • Common Utilities (backbone-common)

Each module is independently usable and documented.


Getting Started

Add the required modules to your project:

<dependency>
  <groupId>io.backbone</groupId>
  <artifactId>backbone-throttle</artifactId>
  <version>1.0.0</version>
</dependency>

Each module includes focused documentation and examples.


📚 Documentation


Relationship to Backbone

Backbone Kit is the cross-cutting foundation — rate limiting, observability, structured logging, and the other plumbing most services need before they ship anything a customer or auditor cares about.

Backbone is the same foundation, extended: domain services (auth, users, audit, documents, notifications, BFF), zero-trust security, infrastructure-as-code, and compliance-mapped evidence — licensed and forkable, deployed into your own AWS account.

Backbone Kit is useful either way. If you're building the rest yourself with Quarkus, it's a head start worth getting right the first time. If you'd rather not spend runway rebuilding identity, observability, security and scaling from scratch, then Backbone is the more complete starting point.


Support

Backbone Kit is open-source and community-supported — issues and PRs welcome.

For teams weighing DIY against a complete, licensed foundation, or wanting architectural input on standing up the full stack, see 👉 Backbone.


License

Backbone Kit is licensed under the MIT License.

About

Infrastructure components for Quarkus services: rate limiting, metrics, health checks, and operational best practices.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Packages

Used by

Contributors

Languages