# Sermant使用介绍

Sermant 是基于Java字节码增强技术的云原生无代理服务网格，通过 JavaAgent 对宿主应用进行非侵入式增强，以解决Java应用的微服务治理问题。Sermant的初衷是建立一个面向微服务治理的对开发态非侵入的解决方案生态，降低服务治理开发和使用的难度，通过抽象接口、功能整合、插件隔离等手段，达到简化开发、功能即插即用的效果。本文介绍Sermant目前包含的组件以及Sermant的编译打包。

# 架构简介

Sermant整体架构包括sermant-agent、Backend、动态配置中心、sermant-injector等组件。其中sermant-agent为核心字节码增强的实现组件，其余为Sermant架构的配套组件。

# sermant-agent

sermant-agent为Sermant必要核心组件，其包含sermant-agentcore (opens new window)、sermant-plugins (opens new window)、sermant-common (opens new window)等字节码增强逻辑的实现主体，在宿主应用启动时通过-javaagent参数指定sermant-agent.jar包来挂载生效。

sermant-agent基于JavaAgent技术，支持JDK 1.6及以上版本。

更多sermant-agent使用指南请参考sermant-agent使用手册。

# Backend

Backend为Sermant数据处理后端模块和前端信息展示模块，当前主要包括Sermant心跳信息的接收和展示等功能。

Backend为Sermant的非必要组件，但是非常推荐用户部署Backend以获得Sermant的可观测性。

更多Backend使用指南请参考Backend使用手册。

# 动态配置中心

动态配置中心为Sermant动态配置功能启用后必要配套组件，该功能允许Sermant动态从配置中心拉取配置以实现丰富多样的服务治理能力，例如标签路由、流控等。如不开启Sermant动态配置能力，动态配置中心可无需部署。

Sermant动态配置中心目前支持两种类型：Zookeeper (opens new window)和ServiceComb Kie (opens new window)。

更多动态配置中心使用指南请参考Sermant动态配置中心使用手册。

# sermant-injector

Sermant支持在容器环境下通过sermant-injector组件实现宿主应用自动挂载Sermant的快速部署方式，只需在应用部署的yaml中的labels添加sermant-injection: enabled即可实现该功能。

sermant-injector为Sermant非必要组件，但是非常推荐用户在容器环境中部署该组件以获得快速部署能力。当前sermant-injector支持在k8s 1.15版本及以上环境部署。

更多sermant-injector使用指南请参考sermant-injector使用手册。

# 编译打包

# 打包方式

Sermant项目中包含以下几种profile，对应不同使用场景：

• agent: 编译打包核心功能和发布的稳定版本插件。
• release: 发布构建产物到中央仓库
• test: 编译打包所有项目模块

执行以下maven命令，对Sermant工程使用agent进行打包：

mvn clean package -DskipTests -Pagent

命令执行完毕后，工程目录下将生成一个形如sermant-agent-x.x.x的文件夹和形如sermant-agent-x.x.x.tar.gz的压缩文件，后者为Sermant的产品包，前者则为产品包解压后的内容。

# 产品目录说明

sermant-agent-x.x.x目录下包含以下内容

• agent: 包含sermant-agent相关内容
  • config: 包含Sermant配置文件
  • core: 包含Sermant的核心框架包
  • implement: 包含Sermant核心功能实现包
  • common: 包含Sermant公共依赖包
  • pluginPackage: 包含各扩展功能插件包以及配置文件等
  • sermant-agent.jar: Sermant入口包，-javaagent参数的指定入口
• server: 包含Sermant的服务端，例如Backend等。