Skip to content

Latest commit

 

History

History
110 lines (67 loc) · 5.13 KB

README.md

File metadata and controls

110 lines (67 loc) · 5.13 KB
Raw

A Proxyless Service Mesh Based on Bytecode Enhancement

简体中文 | English

CNCF Landscape License CI/IT Tests codecov

What is Sermant?

Sermant (also known as Java-mesh) is a proxyless service mesh based on Java bytecode enhancement technology. It utilizes Java bytecode enhancement to provide service governance capabilities to applications, addressing service governance issues in large-scale microservices architectures.

Sermant's vision also includes building a plugin development ecosystem to assist developers in more easily creating service governance functionalities without interfering with the application's source code. The Sermant architecture is depicted as follows.

pic

As described above, Sermant's JavaAgent 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 JavaAgent 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.

pic

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

Quick Start

Below is a simple demo that guides new users to use Sermant in just 4 steps.

Preparation

  • Download Sermant Release package (The current version recommended is 1.4.0)
  • Download Demo binary product compression package
  • Download and start zookeeper

Obtain Demo binary products

Decompress the demo binary product compression package to obtain the spring-provider.jar.

Modify the Sermant configuration

Modify the agent.service.heartbeat.enable and agent.service.gateway.enable configuration in the ${path}/sermant-agent-x.x.x/agent/config/config.properties file to be true, which is to open the heartbeat service and the gateway service of Sermant, as shown below:

agent.service.heartbeat.enable=true
agent.service.gateway.enable=true

Note: path is the path where the Sermant package is downloaded

Start Sermant Backend

Execute the following command in the ${path}/sermant-agent-x.x.x/server/sermant directory:

java -jar sermant-backend-x.x.x.jar

Note: path is the path where the Sermant package is downloaded

Start Demo application

Execute the following command in the directory where the spring-provider.jar file is located:

# linux mac
java -javaagent:${path}/sermant-agent-x.x.x/agent/sermant-agent.jar -jar spring-provider.jar

# windows
java -javaagent:${path}\sermant-agent-x.x.x\agent\sermant-agent.jar -jar spring-provider.jar

Note: path is the path where the Sermant package is downloaded

Verification

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

pic

License

Sermant adopts Apache 2.0 License.

How to Contribute

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

More Documents to Follow

Sermant website | RoadMap | Membership

Contact Us