feat: DEVOPS-1887 opentelemetry metrics sample dashboard (#2470)

Author: pabops

README.md

@@ -121,10 +121,11 @@ otlp_collector_endpoint = "http://otel-collector:4317"
 There is a docker-compose project that includes the OpenTelemetry configuration and tech stack that can be run in local environment for testing purposes:
 
 ```bash
-cd infra/opentelemetry
-docker-compose up
+docker-compose -f infra/opentelemetry/compose.yaml up -d
 ```
 
+After the services are running, a sample dashboard could be obtained from the (Grafana)[http://localhost:9010] local service.
+
 ## `rustfmt`
 
 We use a couple of nightly-only rustfmt features. The easiest way to get these is:

infra/opentelemetry/docker-compose.yaml infra/opentelemetry/compose.yamlinfra/opentelemetry/docker-compose.yaml renamed to infra/opentelemetry/compose.yaml

@@ -1,16 +1,13 @@
-# docker-compsoe file for testing networking with static IPs
-version: "3"
 services:
   node0_with_otel:
-    depends_on:
-      - node3_with_otel
     environment:
       RUST_BACKTRACE: 1
       RUST_LOG: zilliqa=info,opentelemetry=trace
+      OTEL_RESOURCE_ATTRIBUTES: service.name=node0,deployment.environment=local
     image: zq2-node0
     build:
-      context: .
-      dockerfile: Dockerfile
+      context: ${PWD}
+      dockerfile: ${PWD}/Dockerfile
     container_name: zilliqanode0_with_otel
     volumes:
       - "./config_docker.toml:/config.toml"
@@ -24,12 +21,16 @@ services:
 
   node1_with_otel:
     depends_on:
-      - node3_with_otel
+      - node0_with_otel
     environment:
       RUST_BACKTRACE: 1
       RUST_LOG: zilliqa=info,opentelemetry=trace
+      OTEL_RESOURCE_ATTRIBUTES: service.name=node1,deployment.environment=local
     container_name: zilliqanode1_with_otel
     image: zq2-node0
+    build:
+      context: ${PWD}
+      dockerfile: ${PWD}/Dockerfile
     volumes:
       - "./config_docker.toml:/config.toml"
     command:
@@ -40,12 +41,16 @@ services:
 
   node2_with_otel:
     depends_on:
-      - node3_with_otel
+      - node0_with_otel
     environment:
       RUST_BACKTRACE: 1
       RUST_LOG: zilliqa=info,opentelemetry=trace
+      OTEL_RESOURCE_ATTRIBUTES: service.name=node2,deployment.environment=local
     container_name: zilliqanode2_with_otel
     image: zq2-node0
+    build:
+      context: ${PWD}
+      dockerfile: ${PWD}/Dockerfile
     volumes:
       - "./config_docker.toml:/config.toml"
     command:
@@ -55,11 +60,17 @@ services:
         ipv4_address: 198.53.100.102
 
   node3_with_otel:
+    depends_on:
+      - node0_with_otel
     environment:
       RUST_BACKTRACE: 1
       RUST_LOG: zilliqa=info,opentelemetry=trace
+      OTEL_RESOURCE_ATTRIBUTES: service.name=node3,deployment.environment=local
     container_name: zilliqanode3_with_otel
     image: zq2-node0
+    build:
+      context: ${PWD}
+      dockerfile: ${PWD}/Dockerfile
     volumes:
       - "./config_docker.toml:/config.toml"
     command:
@@ -130,6 +141,10 @@ services:
       - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
     ports:
       - "9010:3000"
+    volumes:
+      - ./grafana-datasources.yaml:/etc/grafana/provisioning/datasources/provisioning-datasources.yaml:ro
+      - ./grafana-dashboards.yaml:/etc/grafana/provisioning/dashboards/provisioning-dashboards.yaml:ro
+      - ./zq2-opentelemetry-dashboard.json:/var/lib/grafana/dashboards/zq2-opentelemetry-dashboard.json:ro
     networks:
       - localnet_with_otel
 

infra/opentelemetry/grafana-dashboards.yaml

@@ -0,0 +1,10 @@
+apiVersion: 1
+
+providers:
+  - name: "dashboards"
+    type: file
+    updateIntervalSeconds: 60
+    allowUiUpdates: false
+    options:
+      path: /var/lib/grafana/dashboards
+      foldersFromFilesStructure: true

infra/opentelemetry/grafana-datasources.yaml

@@ -0,0 +1,7 @@
+apiVersion: 1
+
+datasources:
+  - name: Prometheus
+    type: prometheus
+    access: proxy
+    url: http://mimir:9009/prometheus

infra/opentelemetry/otel-collector-config.yaml

@@ -10,10 +10,14 @@ exporters:
 
 processors:
   batch:
+  resourcedetection/docker:
+    detectors: [env, docker]
+    timeout: 2s
+    override: true
 
 service:
   pipelines:
     metrics:
       receivers: [otlp]
-      processors: []
+      processors: [resourcedetection/docker, batch]
       exporters: [prometheusremotewrite]