A demo to show how to get started with building Data Streaming API using gRPC. We will use Redpanda as our streaming platform.
To run the demo you need the following tools on your local machine,
The entire demo is containerized and all the applications could be started using the Docker compose,
docker compose up -dThe docker compose starts the following services,
redpanda-0- A single node Redpanda serverconsole- The Redpanda consoletodo-app-server- The Todo Application gRPC servertodo-list- The Todo Application client that receives the streaming messages from the gRPCtodo-app-server
The Todo application runs with the following environment variables defaults, please change them as needed if you deploy without these defaults.
# gRPC service port
PORT=9090
# Redpanda Brokers
BROKERS=redpanda-0:9092
# Topic to store the Todo
TOPICS=todo-list
# Running environment, typically used for grpcurl
ENV=dev
# The consumer group used while consuming messages
CONSUMER_GROUP_ID=grpc-todo-appSERVICE_ADDRESS=todo-app-server:9090NOTE:
The individual application binaries for Todo App gRPC Server and Todo App Client are available on the application repo. You can download them and run the application individually.
grpcurl -plaintext "localhost:$PORT" listShould return an output like,
grpc.reflection.v1.ServerReflection
grpc.reflection.v1alpha.ServerReflection
todo.Todo
grpcurl -plaintext "localhost:$PORT" list todo.TodoIt should return the following methods,
todo.Todo.AddTodo
todo.Todo.TodoList
On a new terminal run the following command to view the list of Todos added by earlier steps,
docker compose logs -f todo-listThe output should be something like,
todo-list | 2023-12-05T05:20:19.235Z INFO client/main.go:44 Task {"Title": "Finish gRPC Demo README", "Description": "Complete the README update of the gRPC Data Streaming Demo App.", "Completed": false, "Last Updated": "Thursday, 01-Jan-70 00:00:00 UTC", "Partition": 0, "Offset": 0}
todo-list | 2023-12-05T05:20:19.236Z INFO client/main.go:44 Task {"Title": "Finish gRPC Demo README", "Description": "Complete the README update of the gRPC Data Streaming Demo App.", "Completed": false, "Last Updated": "Thursday, 01-Jan-70 00:00:00 UTC", "Partition": 0, "Offset": 1}TIP:
You can also use
grpcurl -plaintext "localhost:$PORT" todo.Todo/TodoList
grpcurl -plaintext -d @ "localhost:$PORT" todo.Todo/AddTodo <<EOM
{
"task": {
"title": "Finish gRPC Demo README",
"description": "Complete the README update of the gRPC Data Streaming Demo App.",
"completed": false
}
}
EOMOnce the task is added the terminal running the client should show an output similar to,
{
"Title": "Finish gRPC Demo README",
"Description": "Complete the README update of the gRPC Data Streaming Demo App.",
"Completed": false,
"Last Updated": "Thursday, 01-Jan-70 00:00:00 UTC",
"Partition": 0,
"Offset": 1
}The demo uses the protobuf definitions from https://github.com/kameshsampath/demo-protos
docker compose down
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent