Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
idrissneumann committed Feb 28, 2024
1 parent 21b36c4 commit 23a058e
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ You can also run unit tests by running this command:
docker-compose -f docker-compose-local.yml up --build --abort-on-container-exit imalive-tests
```

Then you can try jaegger UI here for the traces: http://localhost:16686

And prometheus for the metrics: http://localhost:9090
Then you can try:
* jaegger UI here for the traces: http://localhost:16686
* the opentelemetry metrics exporter endpoint: http://localhost:8889/metrics
* prometheus: http://localhost:9090
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Just a dummy healthcheck api for your nodes (support x86 and armhf for raspberry

It provide a http/restful endpoint that you can use as a healthcheck rule to your loadbalancer and also publish a heartbit in stdout (usefull if you collect it in a log/alerting management system such as elasticstack).

BTW we're also providing packages and images for elasticstack (Kibana, Elasticsearch, Filebeat) [here](https://gitlab.comwork.io/oss/elasticstack).

![kibana](./img/kibana.png)

## Table of content
Expand Down Expand Up @@ -166,6 +164,14 @@ You also can log only a json output by making the environment variable `LOG_FORM

You can also configure an OTEL Grpc endpoint using the `OTEL_COLLECTOR_ENDPOINT` environment variable.

Imalive is sending metrics and traces through GRPC OTLP, you'll be able to see your traces on Jaegger like this:

![jaegger](./img/jaegger.png)

And your metrics on Prometheus like this:

![prometheus](./img/prometheus.png)

## Development / contributions

Go see this [documentation](./CONTRIBUTING.md)
Binary file added img/jaegger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/prometheus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23a058e

Please sign in to comment.