Repository files navigation

English |简体中文

README：

• Introduction
• How to use
• Examples
• Frameworks

Polaris-go is golang SDK for Polaris. Polaris is an operation centre that supports multiple programming languages, with high compatibility to differentapplication framework.

Polaris-go provide features listed as below:

• Service instance registration, and health check

  Provides API on/offline registration instance information, with regular report to inform caller server's healthystatus.

• Service discovery

  Provides multiple API, for users to get a full list of server instance, or get one server instance after route rulefiltering and loadbalancing, which can be applied to srevice invocation soon.

• Service circuitbreaking

  Provide API to report the invocation result, and conduct circuit breaker instance/group insolation based on collecteddata, eventually recover when the system allows.

• Service ratelimiting

  Provides API for applications to conduct quota check and deduction, supports rate limit policies that are based onserver level and port.

polaris-go can be referenced by go mod, user can add dependency to go.mod file

goget-ugithub.com/polarismesh/polaris-go

API quick start guide，can reference：QuickStart

A polaris-examples module is included in our project for you to get started with polaris-go quickly. It contains an example, and you can refer to the readme file in the example project for a quick walkthrough.

• quick start
• router example
• circuit breaker example
• rate limiter example
• config center example

Developers usually use HTTP or RPC frameworks to develop distributed service. Polaris SDK is already integrated into some development frameworks. If using these frameworks, you can enable Polaris Service Governance functions without using Polaris SDK directly.

• dubbo-go
  • registry and discovery
  • routing
  • circuit breaker and rate limiter
  • examples
• grpc-go