alibaba/Sentinel

[RFC] Sentinel Node.js version

Open

#743 opened on May 9, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Java (23,109 stars) (8,150 forks)batch import
SoC2021area/polyglothelp wantedkind/feature

Description

Issue Description

Type: feature request

Describe what feature you want

Implement Node.js version of Sentinel, including but not limited to:

  • Basic statistic structure, that is sliding window.
  • Rate limiting, the primary function of Sentinel.
  • Logging, with little or no outside dependencies to avoid potential package conflicts.
  • Extensible metrics interface, that can expose real-time metrics to outside consumer.
  • Embedded API server, to expose controlling API or metrics, etc.
  • Integrate with Sentinel dashboard, may need machine discovery.

Discussions are welcomed!

Contributor guide

Tech stack
nodejsjavascript
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
5
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Node.jsSentinel conceptssliding window algorithmrate limiting principles
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
10
Research direction
This is a large feature request for implementing a Node.js version of Sentinel. The issue outlines several components: sliding window statistics, rate limiting, logging, metrics interface, embedded API server, and dashboard integration. Before starting, a contributor should study the existing Java implementation in the repository to understand the architecture. The design of the sliding window and rate limiting algorithms needs to be carefully planned. The research should also consider how to make the API server lightweight and how to expose metrics. Discussion in comments may provide additional guidance.