Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trstringer/otel-shopping-cart

Sample application illustrating multiple aspects of observability with OpenTelemetry
https://github.com/trstringer/otel-shopping-cart

devops metrics observability opentelemetry telemetry traces

Last synced: 21 days ago
JSON representation

Sample application illustrating multiple aspects of observability with OpenTelemetry

Host: GitHub
URL: https://github.com/trstringer/otel-shopping-cart
Owner: trstringer
Created: 2022-07-23T18:37:14.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-07-03T19:28:07.000Z (7 months ago)
Last Synced: 2024-12-24T05:08:04.509Z (28 days ago)
Topics: devops, metrics, observability, opentelemetry, telemetry, traces
Language: Go
Homepage:
Size: 31.5 MB
Stars: 87
Watchers: 3
Forks: 12
Open Issues: 19
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# OpenTelemetry shopping cart application

Sample application to highlight distributed tracing and other aspects with [OpenTelemetry](https://opentelemetry.io/) including:

* Microservices
* Traffic generator
* Quality of service interruptor
* Traces, metrics, and logs all through OpenTelemetry
* A variety of observability backends for consumption

## Why?

OpenTelemetry can be thought of as observability middleware:

![Middleware](./images/why_overview.png)

These three "layers" can be considered a full implementation. This repo aims at providing all of them (the microservices applications, the OpenTelemetry implementation, and observability backends).

Instead of taking an opinionated approach on what observability backends should be included, this ships multiple:

* Metrics - Prometheus
* Traces - Jaeger and Grafana Tempo
* Logs - Elasticsearch and Grafana Loki

## Usage

There are a few ways to "use" this repository...

### Everything running local in a new kind cluster

```bash
make run-local
```

### Everything in an existing cluster

```bash
make install-tools-and-app
```

### Just the sample application

```bash
make install-app
```

### Just the observability tools

```bash
make install-tools
```

## Viewing telemetry

### Traces

#### Jaeger

```bash
$ make port-forward-jaeger
```

![Jaeger](./images/traces_jaeger.png)

#### Tempo

```bash
$ make port-forward-grafana
```

![Tempo](./images/traces_tempo.png)

### Metrics

```bash
$ make port-forward-grafana
```

![Prometheus](./images/metrics_prometheus.png)

### Logs

#### Elasticsearch

```bash
$ make port-forward-kibana
```

![Elasticsearch](./images/logs_elasticsearch.png)

#### Loki

```bash
$ make port-forward-grafana
```

![Loki](./images/logs_loki.png)

## Cleanup

To cleanup the local environment:

```
$ make stop-local
```

## Application design

![Application design](./images/otel-shopping-cart-design.png)

There are three services in this application:

* **Cart** - Service handling user requests for shopping cart data (written in Go)
* **User** - Handles user verification and lookup requests from the cart service (written in Go)
* **Price** - Serves update pricing information for products (written in Python)

The backend persistent application data storage is with **PostgreSQL**.

Instrumentation is entirely with OpenTelemetry's APIs and SDKs. Telemetry collection is achieved through the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) sending trace data to Jaeger.