https://github.com/kostyay/otel-demo

A demo using OpenTelemetry in GoLang on Google Cloud in microservice architecture with Pubsub and Postgres database.
https://github.com/kostyay/otel-demo

gcp golang microservices opentelemetry pubsub

Last synced: 3 months ago
JSON representation

A demo using OpenTelemetry in GoLang on Google Cloud in microservice architecture with Pubsub and Postgres database.

• Host: GitHub
• URL: https://github.com/kostyay/otel-demo
• Owner: kostyay
• License: mit
• Created: 2023-05-19T16:53:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-08T17:33:20.000Z (over 1 year ago)
• Last Synced: 2024-09-28T14:22:04.100Z (3 months ago)
• Topics: gcp, golang, microservices, opentelemetry, pubsub
• Language: Go
• Homepage:
• Size: 71.3 KB
• Stars: 28
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Otel Demo](logo/otel-demo.png?raw=true "Otel Demo")

# otel-demo

This is a demo application that implements an asynchronous calculator. It consts of a "controller" microservice that

handles connect-go (gRPC) requests and a "worker" microservice that is implemented as a google cloud function. 

The controller microservice schedules work to the worker microservice via google Pubsub. 

The worker microservice receives a calculation request via pubsub, performs the calculation and returns the response back to the controller via pubsub.

The controller them stores the result to a Cloud SQL postgres database.

This demo shows how to use OpenTelemetry in a Go application that is running on GCP. It demonstrates the usage of middleware

to seamlessly propagate context across services and how to use the OpenTelemetry SDK to create custom spans. 

It implements a middleware for google Pubsub that transfers the trace context in the message metadata.

## Slides

Talk: https://www.youtube.com/watch?v=5rjTdA6BM1E

You can find the slides for this talk [here](https://docs.google.com/presentation/d/1r1AoSwEDILcf0HmY7jRP9C0ghW33Z7Vs/edit?usp=sharing&ouid=108894967989365154526&rtpof=true&sd=true)

## Architecture

```mermaid

flowchart TD

    CUSTOMER[Customer] ==>|1. Calculate expression| CONTROLLER(Controller)

    CONTROLLER --> |2. Store scheduled calculation with UUID| DB_STORE[(CloudSQL)]

    CONTROLLER -.-> |3. Queue Work| PUBSUB([Pubsub])

    PUBSUB -.-> |4. Get work| MATH(Math Cloud Function)

    MATH --> |5. Calculate| MATH

    MATH -.-> |6. Calculation Result|PUBSUB

    PUBSUB -.-> |7. Result ready| CONTROLLER

    CONTROLLER ---> |8. Save result| DB_STORE

```

## Implementation Details

1. RPC requests are recieved by the __controller__ microservice using the __connect protocol__.

   - It implements the `Calculate` and the `List` methods.

2. The controller stores the request in postgres using Gorm package

3. The controller scheduled calculation using the Pubsub library.

4. The __math__ worker is implemented as a GCP Cloud Function. It receives the calculation request via Pubsub and returns the result via Pubsub.

5. The controller receives the result via Pubsub and stores it in postgres.