dubbo-go-samples

KO | EN

gitlite — search

#javascript #typescript #android #machine-learning #rust #deep-learning #linux #docker #nodejs #java #kubernetes #vue #awesome-list #pytorch

dubbo-go-samples

(★ 298)

Apache dubbo

File Explorer

Download Latest Version (.zip)

- - github-actions.yml
  - golangci-lint.yml
- dependabot.yml
- metrics.png
- run-configurations.png
- samples-rpc-triple-client.png
- samples-rpc-triple-server.png
- - Dockerfile
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- build.sh
- README.md
- README_zh.md
- - pom.xml
  - run.sh
- - pom.xml
  - run.sh
- - user.pb.go
  - user.proto
  - user.triple.go
  - user_provider.go
- pom.xml
- README.md
- README_zh.md
- - react-agent
- - chat.pb.go
  - chat.proto
  - chat.triple.go
- .env.example
- README.md
- README_zh.md
- - README.md
- - pom.xml
  - README.md
  - README_zh.md
- - pom.xml
  - README.md
  - README_zh.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_zh.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_zh.md
- - pom.xml
  - run.sh
- - pom.xml
  - run.sh
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- pom.xml
- README.md
- README_zh.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_zh.md
- - README.md
  - README_zh.md
- - README.md
  - README_zh.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- - README.md
  - README_zh.md
- README.md
- README_zh.md
- - index.html
- README.md
- README_zh.md
- - pom.xml
  - run.sh
- - pom.xml
  - run.sh
- README.md
- README_zh.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_CN.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_zh.md
- - pom.xml
  - run.sh
- - pom.xml
  - run.sh
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- pom.xml
- README.md
- README_CN.md
- - pom.xml
  - run.sh
- - pom.xml
  - run.sh
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- - server2_cert.pem
  - server2_key_pkcs8.pem
  - server_ca_cert.pem
- README.md
- README_CN.md
- - README.md
- - README.md
- - pom.xml
  - README.md
- - config.go
- - chat.pb.go
  - chat.proto
  - chat.triple.go
- .env.example
- README.md
- README_zh.md
- start_servers.bat
- start_servers.sh
- README.md
- README_zh.md
- - Namespace.yml
- - Dockerfile
- - Dockerfile
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- build.sh
- README.md
- README_zh.md
- - docker-compose.yaml
  - otel-collector-config.yaml
  - prometheus.yml
  - README.md
  - README_CN.md
- - README.md
  - README_CN.md
- - Deployment.yml
  - docker-compose.yml
  - grafana.json
  - prometheus_pull.yml
  - prometheus_push.yml
  - README.md
  - README_CN.md
- - cloudshell-tutorial.md
  - cymbal-shops.md
  - development-guide.md
  - development-principles.md
  - jaeger.md
  - memorystore.md
  - service-mesh.md
  - workload-identity.md
- - kubernetes-manifests.yaml
- LICENSE
- Makefile
- README.md
- - README.md
  - README_zh.md
- - README.md
- - README.md
  - README_zh.md
- - README.md
- README.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_CN.md
- - README.md
  - README_CN.md
- - README.md
  - README_zh.md
- - README.md
  - README_CN.md
- - README.md
  - README_CN.md
- - README.md
  - README_CN.md
- README.md
- README_CN.md
- - README.md
  - README_zh.md
- - README.md
- - README.md
  - README_CN.md
- - pom.xml
  - run.sh
- - pom.xml
  - run.sh
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- pom.xml
- README.md
- README_zh.md
- - go.mod
  - go.sum
  - Makefile
  - MAKEFILE_GUIDE.md
  - READEME_CN.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_cn.md
- - pom.xml
- - pom.xml
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- - client1_cert.pem
  - client1_key.pem
  - client2_cert.pem
  - client2_key.pem
  - client_ca_cert.pem
  - client_ca_key.pem
  - create.sh
  - multiple_uri_cert.pem
  - multiple_uri_key.pem
  - openssl.cnf
  - README.md
  - server1_cert.pem
  - server1_key.pem
  - server2_cert.pem
  - server2_key.pem
  - server_ca_cert.pem
  - server_ca_key.pem
  - spiffe_cert.pem
  - spiffe_key.pem
- pom.xml
- README.md
- README_CN.md
- - build.sh
  - Dockerfile
  - go.mod
  - go.sum
  - README.md
  - README_CN.md
- - greet.pb.go
  - greet.proto
  - greet.triple.go
- README.md
- README_CN.md
.asf.yaml
.gitignore
.golangci.yml
.licenserc.yaml
docker-compose.yml
go.mod
go.sum
HOWTO.md
HOWTO_CN.md
integrate_test.sh
LICENSE
Makefile
README.md
README_CN.md
start_integrate_test.sh

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Dubbo-Go Samples

![CI](https://github.com/apache/dubbo-go-samples/workflows/CI/badge.svg)

English | [中文](README_CN.md)

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

Please refer to [HOWTO.md](HOWTO.md) for detailed instructions on running the samples.

## What It Contains

### Samples

* `async`: Callback (asynchronous) and one-way RPC examples.
* `apisix`: Example integrating Apache APISIX with Dubbo-go.
* `book-flight-ai-agent`: Example of booking flights using an AI agent.
* `config_center`: Demonstrates how to use different config centers (including Nacos, Zookeeper, apollo) 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.
  * `custom`: Implements custom client and server filters.
  * `hystrix`: Uses `hystrix-go` to demonstrate circuit breaker protection on Dubbo-go calls.
  * `sentinel`: Demonstrates flow control, isolation, and circuit breaking with Sentinel filters.
  * `polaris/limit`: Uses Polaris as a TPS limiter.
  * `token`: Demonstrates token-based request validation between consumer and provider.
  * `tpslimit`: Demonstrates Dubbo-go's built-in TPS limiting filter with custom limit and rejection strategies.
* `healthcheck`: Service health check example.
* `helloworld`: Basic “Hello World” example for Dubbo-go, also includes Go–Java interoperability.
* `http3`: HTTP/3 (QUIC) protocol support example demonstrating how to use Triple protocol with HTTP/3 for high-performance communication between Go and Java services with TLS encryption.
* `direct`: Triple point-to-point invocation sample without a registry, also includes Go–Java interoperability.
* `game`: Game service example.
* `generic`: Generic invocation examples supporting interoperability between Dubbo-Go and Dubbo Java services, suitable for scenarios without interface information.
* `graceful_shutdown`: Triple graceful shutdown sample for verifying long-connection notice, in-flight request draining, and shutdown timing knobs.
* `integrate_test`: Integration test cases for Dubbo-go samples.
* `java_interop`: Demonstrates interoperability between Java and Go Dubbo implementations.
  * `non-protobuf-dubbo`: Java/Go interoperability with the classic Dubbo protocol and non-protobuf payloads (Hessian2 style).
  * `non-protobuf-triple`: Java/Go interoperability over Triple protocol using non-protobuf payloads.
  * `protobuf-triple`: Java/Go interoperability over Triple protocol with a shared protobuf contract.
  * `service_discovery/interface`: Java/Go interoperability with Nacos using interface-level service discovery (Dubbo2 / legacy Dubbo3 model).
  * `service_discovery/service`: Java/Go interoperability with Nacos using application-level service discovery (Dubbo3 model).
* `llm`: Example of integrating Large Language Models (LLMs) with Dubbo-go.
* `logger`: Logging examples for Dubbo-go applications.
  * `logger/default`: Print to console by default.
  * `logger/level`: Set log isolation level.
  * `logger/rolling`: Output to file.
  * `logger/custom`: Custom logger.
  * `logger/trace-integration`: Integrate OpenTelemetry trace information, automatically injecting trace_id, span_id and other information into logs.
* `observability`: Observability samples for Dubbo-go.
  * `observability/integration`: End-to-end integration-validation sample combining Nacos discovery, Dubbo Triple tracing, an OpenTelemetry Collector, Prometheus/Grafana, and trace-correlated logs.
  * `observability/prometheus_grafana`: 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.
  * `observability/probe`: Demonstrates Dubbo-go Kubernetes probe endpoints (`/live`, `/ready`, `/startup`) and deployment usage.
* `mesh`: Proxy-based service mesh example showing how to deploy Dubbo-go services with Envoy on Kubernetes.
* `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 (including Nacos, Zookeeper, etcd, polaris).
* `retry`: Demonstrates retry mechanisms in Dubbo-go RPC calls.
* `router`: Various Dubbo-go router examples.
  * `router/tag`: Dubbo-go tag router examples.
  * `router/condition`: Dubbo-go condition router examples.
  * `router/script`: Dubbo-go script router examples.
  * `router/polaris`: Quickly experience Polaris' service routing capabilities in Dubbo-go.
  * `router/static_config/tag`: Dubbo-go static tag router example.
  * `router/static_config/condition`: Dubbo-go static condition router example.
* `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.
  * `rpc/triple/openapi`: Demonstrates how to enable OpenAPI documentation for Triple protocol services, including versioned services and non-IDL services.
  * `rpc/rest`: REST protocol example.
* `streaming`: Streaming RPC example, also includes Go–Java interoperability when both use streaming.
* `task`: Task scheduling and execution example.
* `timeout`: Demonstrates timeout handling in Dubbo-go.
* `triple_header_trailer`: Demonstrates Triple request metadata/attachments and response headers/trailers exposed through `http.Header`.
* `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, also includes Go–Java interoperability.
* `transaction/seata-go`: Distributed transaction example using `seata-go`.

### Tools

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

## Integration Test Flow

This repository uses a script-driven integration test flow:

1. `start_integrate_test.sh`: run the full sample list (same as CI).
2. `integrate_test.sh <sample-path>`: run a single sample.

### Run full integration tests

```bash
./start_integrate_test.sh
```

This script will:

* Start dependency services from root `docker-compose.yml`.
* Run dependency health checks.
* Invoke `./integrate_test.sh ...` for each sample in the list.
* Tear down dependency containers on exit (success or failure).

### Run a single sample

```bash
./integrate_test.sh helloworld
./integrate_test.sh direct
```

Main steps of `integrate_test.sh`:

1. Start `go-server` (and optional auxiliary Go servers).
2. Run `go-client`.
3. Run `java-client` (if present and `mvn` is available).
4. Stop `go-server`.
5. Start `java-server` (if present) and wait for port readiness.
6. Run `java-client` and `go-client` again to verify Go/Java interop.

## 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 and refer to [HOWTO.md](HOWTO.md) for detailed instructions.
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.

dubbo-go-samples

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

dubbo-go-samples

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README