# joylive-agent

**Repository Path**: JD-opensource/joylive-agent

## Basic Information

- **Project Name**: joylive-agent
- **Description**: Java bytecode enhancement framework for traffic governance in multi-live (unit) scenarios. 基于字节码增强的面向应用多活和单元化的微服务流量治理框架。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 42
- **Forks**: 12
- **Created**: 2024-07-08
- **Last Updated**: 2025-09-29

## Categories & Tags

**Categories**: microservice

**Tags**: None

## README

# joylive-agent

[![Build](https://github.com/jd-opensource/joylive-agent/actions/workflows/build.yml/badge.svg)](https://github.com/jd-opensource/joylive-agent/actions/workflows/build.yml)
![License](https://img.shields.io/github/license/jd-opensource/joylive-agent.svg)
[![Maven Central](https://img.shields.io/maven-central/v/com.jd.live/joylive-agent.svg?label=maven%20central)](https://search.maven.org/search?q=g:com.jd.live)
[![GitHub repo](https://img.shields.io/badge/GitHub-repo-blue)](https://github.com/jd-opensource/joylive-agent)
[![GitHub release](https://img.shields.io/github/release/jd-opensource/joylive-agent.svg)](https://github.com/jd-opensource/joylive-agent/releases)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/jd-opensource/joylive-agent.svg)](http://isitmaintained.com/project/jd-opensource/joylive-agent "Percentage of issues still open")
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://joylivehq.slack.com)

<img src="docs/image/weixin.png" title="The QR code is valid until 2025/09/22" width="150" />

English | [简体中文](./README-zh.md)

## Overview

Microservice governance framework, leveraging bytecode enhancement technology, 
employs a micro-kernel extensible architecture's proxyless implementation, 
offering superior performance and resource efficiency compared to the sidecar pattern. 
In addition to supporting conventional microservice governance features such as circuit breaking, rate limiting, and degradation, 
it also facilitates swimlane governance and application multi-active traffic governance.
Offers traffic governance plugins for Spring cloud dalston/greenwich/hoxton/2020/2021/2022/2023/2024/2025, Dubbo 2.6/2.7/3, SofaRpc, Rocketmq, and Kafka. 
This enables existing java applications within enterprises to seamlessly integrate traffic governance capabilities without altering business code,
supporting traffic scheduling in same-region, cross-region and multi-cloud multi-active scenarios, 
thereby enhancing business stability and disaster recovery capabilities.

## Architecture
1. Agent for multi-live   
![pic](docs/image/architect-0.png)

2. Agent architect   
![pic](docs/image/architect-1.png)

3. Agent governance theory   
![pic](docs/image/architect-2.png)

4. Agent governance strategy
   ![pic](docs/image/architect-6.png)

5. Agent for full chain gray release based on lane   
![pic](docs/image/architect-3.png)

6. Agent for local cell priority strategy   
![pic](docs/image/architect-4.png)

7. For more information, please refer to the [Architecture Manual](docs/architect.md).

## Related Projects

1. [joylive-injector](https://github.com/jd-opensource/joylive-injector), used for cloud-native scenario auto-injection of `joylive-agent`.

## How to use

### Requirements

Compile requirement: JDK 17+ and Maven 3.2.5+ 

Runtime requirement: JDK 8+

Note: When using IDEA, please disable cross-compilation as shown below:

![pic](docs/image/idea-0.jpg)

## Main Features

1. Supports traffic control for various models, including in-region multi-activity and cross-region multi-activity.
2. Support swimlane-based full-link gray scale, QPS and concurrent current limiting, label routing, load balancing and other microservice governance strategies;
3. Supports local cell priority and cross-cell fault-tolerance strategies.
4. Employs bytecode enhancement technology, which is non-intrusive to business code and minimally impacts business performance.
5. Adopts a microkernel architecture with strong class isolation, featuring an easy-to-use and simple extension and configuration system.

## Quick Start

View [Quick Start](./docs/quickstart.md)

## Configuration reference manual

View [Configuration Reference Manual](./docs/config.md)

## Usage Examples

View [Usage Examples](./docs/example.md)

## Q&A

View [Q&A](./docs/qa.md)

## Release History

View [Release History](./RELEASE.md)

## Roadmap

View [Roadmap](./docs/roadmap.md)