Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bad-logic/distributed-tracing
distributed tracing example with opentelemetry
https://github.com/bad-logic/distributed-tracing
kafka microservices opentelemetry opentelemetry-collector opentelemetry-cpp opentelemetry-go opentelemetry-javascript opentelemetry-python otel trace
Last synced: 2 months ago
JSON representation
distributed tracing example with opentelemetry
- Host: GitHub
- URL: https://github.com/bad-logic/distributed-tracing
- Owner: bad-logic
- Created: 2022-09-25T11:37:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T20:28:09.000Z (2 months ago)
- Last Synced: 2024-11-16T21:26:42.765Z (2 months ago)
- Topics: kafka, microservices, opentelemetry, opentelemetry-collector, opentelemetry-cpp, opentelemetry-go, opentelemetry-javascript, opentelemetry-python, otel, trace
- Language: Python
- Homepage:
- Size: 155 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#### DISTRIBUTED TRACING
In distributed systems, a single operation may traverse across multiple software components. each software components may produce traces/logs that are uniquely identifiable across the participating systems. so it is very difficult to correlate those traces/logs.
In order to correlate those traces/logs, they must share a context that tells them that they are part of a specific transaction/operation.
Trace context is something that can be passed along with the request, that tells the participating system that it is a part of a specific operation.
Trace context is split into two individual propagation fields supporting interoperability and vendor-specific extensibility:
**_traceparent header_** : represents the incoming request in a tracing system in a common format, understood by all vendors.
Format: {version}-{trace_id}-{parent_id}-{trace_flags}
**version** => 2 HEXDIGLC (Hexadecimal digits lowercase)
> The current specification assumes the version is set to 00. Version ff is forbidden
**trace_id** => 32 HEXDIGLC (16 bytes array identifier. All zeroes forbidden)
> All traces belonging to the same transaction will have same trace_id. it is a unique identifier across the distributed system.
[how to generate trace_id ?](https://www.w3.org/TR/trace-context-1/#considerations-for-trace-id-field-generation)
**parent_id** => 16 HEXDIGLC (8 bytes array identifier. All zeroes forbidden)
> It is the id of the caller. In some tracing system it may also be known as the span_id.
**trace_flags** => 2 HEXDIGLC (8 bit flags.)
> The current version of this specification (00) only supports a single flag called sampled.
```
static final byte FLAG_SAMPLED = 1; // 00000001
boolean sampled = (traceFlags & FLAG_SAMPLED) == FLAG_SAMPLED;
```
Ex:
```
00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
base16(version) = 00
base16(trace-id) = 4bf92f3577b34da6a3ce929d0e0e4736
base16(parent-id) = 00f067aa0ba902b7
base16(trace-flags) = 01 // sampled
```
```
00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00
base16(version) = 00
base16(trace-id) = 4bf92f3577b34da6a3ce929d0e0e4736
base16(parent-id) = 00f067aa0ba902b7
base16(trace-flags) = 00 // not sampled
```
**_tracestate header_** (optional): includes the parent in a potentially vendor-specific format
### How to run application !!!
First run kafka
> docker-compose -f deploy/kafka-compose.yaml up -d
Run logging containers
> docker-compose -f deploy/logs-compose.yaml up -d
Run application containers
> docker-compose -f deploy/docker-compose.yaml up
OR
Run with script
```bash
$ chmod +x run.sh
$ ./run.sh
```
Running Migrations
```bash
$ chmod +x migrations.sh
$ ./migrations.sh run
```
Running Applications\
[product microservice](./products/README.md) `localhost:8082/product`\
[order microservice](./orders/README.md) `localhost:8083/order/`\
[kafka ui](./deploy/kafka-compose.yaml#L52) `localhost:8080`\
[Zipkin](./deploy/logs-compose.yaml#L30) `localhost:9411`\
[Jaeger](./deploy/logs-compose.yaml#L22) `localhost:16686`\
[consumer node](./consumer-node/README.md)\
[consumer cpp](./consumers/README.md)