iluwatar / iluwatar/java-design-patterns

Microservice pattern: Microservice chassis

Open
#2,677 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic: pattern info: help wanted status: stale type: feature
Dominant language
Java
Stars
94.7k
Forks
27.4k
Avg merge
3d 4h
Merged PRs (30d)
10

Description

Description

The Microservice Chassis design pattern is a foundational framework for developing microservices that encapsulate common concerns, such as logging, configuration, and security. By creating a chassis, developers can focus on business logic without reinventing the wheel for these standard features. This pattern promotes consistency, reduces boilerplate code, and simplifies maintenance.

Main Elements of the Pattern
  • Service Configuration: Centralized management of configurations for each microservice.
  • Service Discovery: Mechanisms for services to discover each other, typically using a registry.
  • Logging: Standardized logging format across services to simplify debugging and monitoring.
  • Security: Common security practices, such as authentication and authorization, implemented uniformly.
  • Monitoring and Metrics: Integrated tools for monitoring service health and performance metrics.
List of References
Acceptance Criteria
  1. A new module named microservices-chassis is created under the project structure.
  2. Implement basic configurations, service discovery, logging, security, and monitoring features within the module.
  3. Provide comprehensive documentation and examples demonstrating how to use the microservice chassis in a sample microservice.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the project's contribution guidelines and structure to determine where a new microservices-chassis module belongs; no existing files or tests are named in the issue. Define the module around configuration, service discovery, logging, security, and monitoring, then provide the requested sample-microservice documentation and examples. Done means the module and its documented examples cover all five listed concerns.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, distributed-systems
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.