go-masonry / tutorial

step-by-step tutorial on how to build gRPC server with mortar

Tutorial

NOTE This tutorial is outdated, instead read here: https://go-masonry.github.io and use this template

This tutorial will explain how to build a gRPC web service using go-masonry/mortar step by step.

Prerequisites

• You should be familiar with Protobuf, gRPC and REST / Swagger
  • Install everything related to gRPC starting here
• You should understand what Dependency Injection is
• Have access to Jaeger service - Optional
• Have access to Prometheus - Optional

How to read this tutorial

There are 7 parts in this tutorial, each part adds on top of previous one

1. Tutorial service API
2. Project structure and business logic
3. Dependency Injection and Mortar
4. Wiring/Instrumentation of everything together
5. Mortar Middleware (Tracing, Monitoring, etc)
6. Tests example
7. Makefile

You can create a local git repository and copy 01-api to it. Once you seen/understand the code, commit. Then copy 02-api contents to your directory. This will overwrite some code.

Repeat for each subsequent part. This way you will have git to show you what actually changed.

*** Make sure to adjust imports accordingly.

Alternate way to pass through tutorial

Read the docs of all 7 parts described above and clone the alternate-example. You'll find there almost the same code organized in a different way: there are 2 independent microservices and common module.

tutorial's Issues

LoggerWriterConsole is only defined in [email protected]

Hello, I'm at step 04-instrumentation. The constant LoggerWriterConsole is no longer defined in latest [email protected].

I did a quick look at my GOROOT, locally I have [email protected], [email protected], [email protected] and [email protected].

I found this constant only in [email protected] and substituted "mortar.logger.console" into app/mortar/logger.go:zeroLogBuilder to get things going.

Undefined mortar.Name in metrics.go and tracing.go

In 05-middleware

app/mortar/metrics.go:24:18: undefined: mortar.Name
app/mortar/tracing.go:25:29: undefined: mortar.Name

both mortarProject.Name and mortar.Name can be replaced by the string "mortar.name"

Missing workshop.mustEmbedUnimplementedWorkshopServer and workshop.mustEmbedUnimplementedSubWorkshopServer methods

Hello,
I'm at step 04-instrumentation. When running go run main.go config config/config.yml with files generated via the latest protoc plugins I encountered the above errors.

gRPC-Gateway version: grpc-gateway/[email protected]

protoc command line: protoc -I"../../googleapis/" -I. --openapiv2_out . --openapiv2_opt logtostderr=true --grpc-gateway_out=repeated_path_param_separator=ssv:. --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative garage.proto

Resolution: the types within two files, listed below, were slightly changed:

app/controllers/workshop.go

type workshopController struct {
	deps    workshopControllerDeps
	client  *http.Client
	encoder *jsonpb.Marshaler
	workshop.UnimplementedWorkshopServer
}

app/controllers/subworkshop.go

type subWorkshopController struct {
	deps subWorkshopControllerDeps
	workshop.UnimplementedSubWorkshopServer
}