Dubbo-Go Samples

English | 中文

A collection of runnable Dubbo-go examples covering configuration, registries, observability, interoperability, service mesh, and more.

What It Contains

Samples

• async: Callback (asynchronous) and one-way RPC examples.
• book-flight-ai-agent: Example of booking flights using an AI agent.
• config_center: Demonstrates how to use different config centers (e.g., Nacos, Zookeeper) for configuration management.
• config_yaml: Shows how to configure Dubbo-go applications using YAML files.
• context: Demonstrates passing user data (attachments) via Go context between client and server.
• error: Error-handling examples in Dubbo-go.
• filter: Demonstrates the use of built-in and custom filters in Dubbo-go.
  • polaris/limit: Uses Polaris as a TPS limiter.
• healthcheck: Service health check example.
• helloworld: Basic “Hello World” example for Dubbo-go, also includes Go–Java interoperability.
• direct: Triple point-to-point invocation sample without a registry.
• game: Game service example.
• generic: Generic invocation examples supporting interoperability between Dubbo-Go and Dubbo Java services, suitable for scenarios without interface information.
• integrate_test: Integration test cases for Dubbo-go samples.
• java_interop: Demonstrates interoperability between Java and Go Dubbo implementations.
• llm: Example of integrating Large Language Models (LLMs) with Dubbo-go.
• logger: Logging examples for Dubbo-go applications.
• metrics: Shows how to collect and expose metrics from Dubbo-go services, supporting both Prometheus Push and Pull modes. Also includes the pgw-cleaner tool for cleaning zombie metrics in Push mode.
• online_boutique: Microservices “online boutique” demo built with Dubbo-go.
• otel/tracing: Distributed tracing examples using OpenTelemetry.
  • stdout: Uses stdout exporter to export tracing data.
  • otlp_http_exporter: Uses otlpHttpExporter to export tracing data, covering dubbo/triple/jsonrpc protocols.
• registry: Examples of using different service registries (e.g., Nacos, Zookeeper).
• retry: Demonstrates retry mechanisms in Dubbo-go RPC calls.
• rpc: Various RPC protocol examples with Dubbo-go.
  • rpc/dubbo: Dubbo protocol example, including Java–Go interop.
  • rpc/grpc: gRPC protocol example.
  • rpc/jsonrpc: JSON-RPC protocol example.
  • rpc/triple: Triple protocol example with multiple serialization formats.
• streaming: Streaming RPC example.
• task: Task scheduling and execution example.
• timeout: Demonstrates timeout handling in Dubbo-go.
• tls: Demonstrates how to use TLS (based on X.509 certificates) in Dubbo-go to enable encrypted communication and/or mutual authentication between client and server.
• transaction/seata-go: Distributed transaction example using seata-go.

compatibility (legacy Dubbo-go samples)

• compatibility/apisix: Example integrating Apache APISIX with Dubbo-go.
• compatibility/config-api: Shows how to use Dubbo-go via APIs without configuration files.
• compatibility/configcenter: Usage of different config centers, including Zookeeper, Nacos, and Apollo.
• compatibility/generic: Generic invocation example.
• compatibility/mesh: Proxy-based service mesh example showing how to deploy Dubbo-go services with Envoy on Kubernetes.
• compatibility/proxyless: Proxyless service mesh example for deploying Dubbo-go services on Kubernetes.
• compatibility/polaris: Dubbo-go integrate with polaris samples.
  • compatibility/polaris/limit: Quickly experience Polaris' service current limiting capabilities in dubbogo
  • compatibility/polaris/registry: Quickly experience Polaris' service registration and service discovery capabilities in dubbogo
  • compatibility/polaris/router: Quickly experience Polaris' service routing capabilities in dubbogo
• compatibility/rpc: Dubbo protocol communication examples.
  • compatibility/rpc/dubbo: Dubbo-go 3.0 RPC example between Java and Go.
  • compatibility/rpc/grpc: Dubbo-go RPC example based on gRPC.
  • compatibility/rpc/jsonrpc: Dubbo-go RPC example based on JSON-RPC.
  • compatibility/rpc/triple: Dubbo-go RPC examples based on hessian2/msgpack/pb (protobuf v3)/pb2 (protobuf v2)/self-defined serialization.
• compatibility/skywalking: How to integrate SkyWalking with Dubbo-go.
• compatibility/tls: Uses TLS encryption in getty (TCP)/triple/gRPC communication modes.
• compatibility/tracing: Tracing examples.

Tools

• pgw-cleaner: Operations and maintenance tool for cleaning up zombie metrics in Prometheus Push mode.

How To Run

Please refer to HOWTO.md for detailed instructions on running the samples.

How to Contribute

If you want to add more samples, please follow these steps:

1. Create a new subdirectory and give it an appropriate name for your sample. If you are unsure how to organize your code, follow the layout of the existing samples.
2. Make sure your sample works as expected before submitting a PR, and ensure GitHub CI passes after the PR is submitted. You can refer to the existing samples to learn how to test your sample.
3. Provide a README.md in your sample directory to explain what your sample does and how to run it.