diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad859bc..ac8ddba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index c2f4aca..ce09bc2 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) diff --git a/img/jaegger.png b/img/jaegger.png new file mode 100644 index 0000000..2e60aea Binary files /dev/null and b/img/jaegger.png differ diff --git a/img/prometheus.png b/img/prometheus.png new file mode 100644 index 0000000..4551ccb Binary files /dev/null and b/img/prometheus.png differ