CloudWeGo-Kitex

English | 中文

Kitex [kaɪt'eks] is a high-performance and strong-extensibility Golang RPC framework that helps developers build microservices. If the performance and extensibility are the main concerns when you develop microservices, Kitex can be a good choice.

Basic Features

• High Performance

Kitex integrates Netpoll, a high-performance network library, which offers significant performance advantage over go net.

• Extensibility

Kitex provides many interfaces with default implementation for users to customize. You can extend or inject them into Kitex to fulfill your needs (please refer to the framework extension section below).

• Multi-message Protocol

Kitex is designed to be extensible to support multiple RPC messaging protocols. The initial release contains support for Thrift, Kitex Protobuf and gRPC, in which Kitex Protobuf is a Kitex custom Protobuf messaging protocol with a protocol format similar to Thrift. Kitex also supports developers extending their own messaging protocols.

• Multi-transport Protocol

For service governance, Kitex supports TTHeader and HTTP2. TTHeader can be used in conjunction with Thrift and Kitex Protobuf; HTTP2 is currently mainly used with the gRPC protocol, and it will support Thrift in the future.

• Multi-message Type

Kitex supports PingPong, One-way, and Bidirectional Streaming. Among them, One-way currently only supports Thrift protocol, two-way Streaming only supports gRPC, and Kitex will support Thrift's two-way Streaming in the future.

• Service Governance

Kitex integrates service governance modules such as service registry, service discovery, load balancing, circuit breaker, rate limiting, retry, monitoring, tracing, logging, diagnosis, etc. Most of these have been provided with default extensions, and users can choose to integrate.

• Code Generation

Kitex has built-in code generation tools that support generating Thrift, Protobuf, and scaffold code.

Documentation

• Getting Started

• User Guide

  • Basic Features

  Including Message Type, Supported Protocols, Directly Invoke, Connection Pool, Timeout Control, Request Retry, LoadBalancer, Circuit Breaker, Rate Limiting, Instrumentation Control, Logging and HttpResolver.[more] - Governance Features

  Supporting Service Discovery, Monitoring, Tracing and Customized Access Control.[more] - Advanced Features

  Supporting Generic Call and Server SDK Mode.[more] - Code Generation

  Including Code Generation Tool and Combined Service.[more] - Framework Extension

  Providing Middleware Extensions, Suite Extensions, Service Registry, Service Discovery, Customize LoadBalancer, Monitoring, Logging, Codec, Transport Module, Transport Pipeline, Metadata Transparent Transmission, Diagnosis Module.[more]

• Reference

  • For Transport Protocol, Exception Instruction and Version Specification, please refer to doc

• FAQ

Performance

Performance benchmark can only provide limited reference. In production, there are many factors can affect actual performance.

We provide the kitex-benchmark project to track and compare the performance of Kitex and other frameworks under different conditions for reference.

Related Projects

• Netpoll: A high-performance network library.
• kitex-contrib: A partial extension library of Kitex, which users can integrate into Kitex through options according to their needs.
• Example: Use examples of Kitex.

Blogs

• Performance Optimization on Kitex
• ByteDance Practice on Go Network Library
• Getting Started With Kitex's Practice: Performance Testing Guide

Contributing

Contributing.

License

Kitex is distributed under the Apache License, version 2.0. The licenses of third party dependencies of Kitex are explained here.

Community

• Email: conduct@cloudwego.io
• How to become a member: COMMUNITY MEMBERSHIP
• Issues: Issues
• Lark: Scan the QR code below with Lark to join our CloudWeGo/kitex user group.

Landscapes

  

CloudWeGo enriches the CNCF CLOUD NATIVE Landscape.