tianxiaoliang/Sermant

A proxyless service mesh solution based on Java Agent

What is Sermant

Sermant (also known as Java-mesh) is a proxyless service mesh technology based on Java Agent . It leverages the Java Agent to instrument the host application with enhanced service governance function, in order to solve the service governance problem, in the massive micro-service architecture.

Sermant's purpose also includes building a plugin-development ecosystem to help developers develop the service governance function more easily while not interfering the business code. The Sermant architecture is depicted as follows.

As described above, Sermant's Java Agent has two layers of functions.

Framework core layer. The core layer provides Sermant's basic framework capability, in order to ease the plugin development. The function of this layer includes heart beat, data transmit, dynamic configuration, etc.
Plugin service layer. The plugin provides actual governance service for the application. The developer can either develop simple plugin by directly leveraging framework core service, or can develop complex plugin by developing plugin's own complex service-governance function.

Sermant's Java Agent widely adopts class isolation technology in order to eliminate the class load conflicts between framework code, plugin code, and application code.

A microservice architecture using Sermant has the following three components, which is depicted in the following diagram.

Sermant Java Agent: dynamically instrument the application for the service governance capability.
Sermant Backend: provide the connection and the pre-processing service for the Java Agents' all uploaded-data.
Dynamic configuration center: Providing the instructions by dynamically update the config to the listening Java Agent. Dynamic configuration center is not directly provided by Sermant project. The projects currently support servicecomb-kie, etc.

Quick start

Download or compile

Click here to download Sermant binary package. If you will to compile the project yourself, please follow the following steps.

Execute maven command to package the Sermant project's demo module.

mvn clean package -Dmaven.test.skip -Pexample

Start Sermant

Start Sermant backend, Prepare zookeeper.

# Run under Linux
java -jar sermant-agent-x.x.x/server/sermant/sermant-backend-x.x.x.jar

# Run under Windows
java -jar sermant-agent-x.x.x\server\sermant\sermant-backend-x.x.x.jar

Start Sermant demo project:

# Run under Linux
java -cp sermant-example/demo-application/target/demo-application.jar \
  -javaagent:sermant-agent-x.x.x/agent/sermant-agent.jar=appName=test \
  com.huawei.example.demo.DemoApplication

# Run under Windows
java -cp sermant-example\demo-application\target\demo-application.jar ^
  -javaagent:sermant-agent-x.x.x\agent\sermant-agent.jar=appName=test ^
  com.huawei.example.demo.DemoApplication

Check running status of Sermant. In this example, open the browser and navigate to the URL "http://localhost:8900".

Please refer to the Service Register & Discovery Plugin QuickStart for details.

License

Sermant adopts Apache 2.0 License.

How to contribute

Please read Contribute Guide to refer how to jion the contribution.

Declaration

Apache/Servicecomb-java-chassis: Sermant refer the service governance algorithm from Apache Servicecomb project.
Apache/Servicecomb-kie: Sermant uses servicecomb-kie as the default dynamic configuration center.
Apache/SkyWalking: The plugin architecture in this project is refered to Apache Skywalking. Part of the framework code in Sermant is built based on Apache Skywalking project as well.
Alibaba/Sentinel: Sermant's flow-control plugin is built based on Alibaba Sentinel project.

tianxiaoliang / Sermant