Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gentooxativa/practical-opentelemetry
Knowledge Sharing about OpenTelemetry
https://github.com/gentooxativa/practical-opentelemetry
jaeger javascript observability opentelemetry tracing tracking tutorial-code
Last synced: 1 day ago
JSON representation
Knowledge Sharing about OpenTelemetry
- Host: GitHub
- URL: https://github.com/gentooxativa/practical-opentelemetry
- Owner: GentooXativa
- License: mit
- Created: 2023-06-29T07:07:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-27T08:45:18.000Z (over 1 year ago)
- Last Synced: 2024-11-30T12:13:34.732Z (2 months ago)
- Topics: jaeger, javascript, observability, opentelemetry, tracing, tracking, tutorial-code
- Language: JavaScript
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# practical-opentelemetry
Knowledge Sharing about OpenTelemetry
- [practical-opentelemetry](#practical-opentelemetry)
- [Description](#description)
- [Requisites](#requisites)
- [How to run](#how-to-run)
- [How to stop](#how-to-stop)
- [Recommended Readings](#recommended-readings)
- [APIs used on this demo](#apis-used-on-this-demo)
## Description
This is a demostration on how we can implement [OpenTelemetry](https://opentelemetry.io/) on a NodeJS project and interact with it using [Jaeger](https://www.jaegertracing.io/) a end-to-end distributed open-source tracing solution.
## Requisites
- NodeJS version 20, you can use [nvm](https://github.com/nvm-sh/nvm) version manager to get it `nvm use`
- Any browser
- An editor of your choice
## How to run
You only need to use docker-compose to run it:
```bash
docker compose up
```
if you are using an older version of docker:
```bash
docker-compose up
```
Then you can go to [http://localhost:16686/](http://localhost:16686/) to see the Jaeger UI and see the traces.
## How to stop
```bash
docker compose down
```
or
```bash
docker-compose down
```
You can use `CONTROL+C` at any time to stop it.
## Recommended Readings
- Open Telemetry documentation: https://opentelemetry.io/docs/
- Instrumentation for different languages: https://opentelemetry.io/docs/instrumentation/
- Jaeger documentation: https://www.jaegertracing.io/docs/
- Obervability VS Monitoring VS Telemetry: https://cribl.io/blog/observability-vs-monitoring-vs-telemetry/
- Observability VS Monitoring: https://www.ibm.com/cloud/blog/observability-vs-monitoring
## APIs used on this demo
All of this API are free to use, and some of them have limitations so after 1 or 2 runs you will get quota errors or something like that.
- https://catfact.ninja/fact
- https://api.chucknorris.io/jokes/random
- https://official-joke-api.appspot.com/random_joke
- https://api.kanye.rest/
- https://ifconfig.me/all.json