Merge pull request #6 from cloudhubs/add-open-telemetry

Add open telemetry
cloudhubs · Apr 21, 2024 · 7bfd9e8 · 7bfd9e8
2 parents ede221d + 9ec57be
commit 7bfd9e8
Show file tree

Hide file tree

Showing 36 changed files with 9,490 additions and 1 deletion.
diff --git a/.env b/.env
@@ -0,0 +1,35 @@
+# Dependent images
+COLLECTOR_CONTRIB_IMAGE=otel/opentelemetry-collector-contrib:0.97.0
+GRAFANA_IMAGE=grafana/grafana:10.4.1
+JAEGERTRACING_IMAGE=jaegertracing/all-in-one:1.55
+# must also update version field in /src/grafana/provisioning/datasources/opensearch.yml
+OPENSEARCH_IMAGE=opensearchproject/opensearch:2.12.0
+PROMETHEUS_IMAGE=quay.io/prometheus/prometheus:v2.51.1
+
+# OpenTelemetry Collector
+OTEL_COLLECTOR_HOST=otelcol
+OTEL_COLLECTOR_PORT_GRPC=4317
+OTEL_COLLECTOR_PORT_HTTP=4318
+OTEL_EXPORTER_OTLP_ENDPOINT=http://${OTEL_COLLECTOR_HOST}:${OTEL_COLLECTOR_PORT_HTTP}
+
+# OpenTelemetry Resource Definitions
+OTEL_RESOURCE_ATTRIBUTES="service.namespace=ts-microservices"
+
+# Metrics Temporality
+OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=cumulative
+
+# ********************
+# Telemetry Components
+# ********************
+# Grafana
+GRAFANA_SERVICE_PORT=3000
+GRAFANA_SERVICE_HOST=grafana
+
+# Jaeger
+JAEGER_SERVICE_PORT=16686
+JAEGER_SERVICE_HOST=jaeger
+
+# Prometheus
+PROMETHEUS_SERVICE_PORT=9090
+PROMETHEUS_SERVICE_HOST=prometheus
+PROMETHEUS_ADDR=${PROMETHEUS_SERVICE_HOST}:${PROMETHEUS_SERVICE_PORT}
diff --git a/README.md b/README.md
@@ -1 +1,34 @@
-# train-ticket-microservices
+# train-ticket-microservices
+
+## Dependencies
+
+The only dependency for running the project is docker and docker compose, it was tested with the following dependencies:
+```yaml
+Docker Desktop: 4.29.0 (145265)
+Docker Engine: 26.0.0
+Docker Compose: v2.26.1-desktop.1
+```
+
+Lower versions should work too
+
+## Start system
+
+### Start basic system
+
+In order to start the system with minimum configuration needs to run the following command:
+
+```sh
+docker compose --build -d
+```
+
+This command is going to pull and build all the necessary images needed for the system.
+
+### Start with telemetry
+
+By default the system is not started with telemetry, in order to run it with telemetry needs to run the following command:
+
+```sh
+docker compose -f ./docker-compose.yml -f ./docker-compose.override.telemetry.yml up --build -d
+```
+
+This command just include the telemetry to the base definition, so any change made to the base configuration is being made here too.
diff --git a/docker-compose.override.telemetry.yml b/docker-compose.override.telemetry.yml
@@ -0,0 +1,311 @@
+services:
+ ts-new-gateway:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsnewgateway
+ ts-order-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsorderservice
+ ts-food-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsfoodservice
+ ts-cancel-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tscancelservice
+ ts-admin-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsadminservice
+ ts-assurance-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsassuranceservice
+ ts-auth-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsauthservice
+ ts-config-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsconfigservice
+ ts-consign-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsconsignservice
+ ts-contacts-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tscontactsservice
+ ts-delivery-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsdeliveryservice
+ ts-notification-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsnotificationservice
+ ts-order-related-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsorderrelatedservice
+ ts-preserve-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tspreserveservice
+ ts-price-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tspriceservice
+ ts-rebook-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsrebookservice
+ ts-route-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsrouteservice
+ ts-security-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tssecurityservice
+ ts-station-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsstationservice
+ ts-travel-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tstravelservice
+ ts-user-service:
+ build:
+ target: telemetry
+ environment:
+ - OTEL_EXPORTER_OTLP_ENDPOINT
+ - OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
+ - OTEL_RESOURCE_ATTRIBUTES
+ - OTEL_LOGS_EXPORTER=otlp
+ - OTEL_SERVICE_NAME=tsuserservice
+ # ********************
+ # Telemetry Components
+ # ********************
+ # Jaeger
+ jaeger:
+ image: ${JAEGERTRACING_IMAGE}
+ container_name: jaeger
+ command:
+ - "--memory.max-traces=5000"
+ - "--query.base-path=/jaeger/ui"
+ - "--prometheus.server-url=http://${PROMETHEUS_ADDR}"
+ - "--prometheus.query.normalize-calls=true"
+ - "--prometheus.query.normalize-duration=true"
+ deploy:
+ resources:
+ limits:
+ memory: 400M
+ restart: unless-stopped
+ ports:
+ - "${JAEGER_SERVICE_PORT}:${JAEGER_SERVICE_PORT}" # Jaeger UI
+ - "${OTEL_COLLECTOR_PORT_GRPC}"
+ networks:
+ - ts-dkr-network
+ environment:
+ - METRICS_STORAGE_TYPE=prometheus
+
+ # Grafana
+ grafana:
+ image: ${GRAFANA_IMAGE}
+ container_name: grafana
+ deploy:
+ resources:
+ limits:
+ memory: 100M
+ restart: unless-stopped
+ networks:
+ - ts-dkr-network
+ environment:
+ - "GF_INSTALL_PLUGINS=grafana-opensearch-datasource"
+ volumes:
+ - ./telemetry/grafana/grafana.ini:/etc/grafana/grafana.ini
+ - ./telemetry/grafana/provisioning/:/etc/grafana/provisioning/
+ ports:
+ - "${GRAFANA_SERVICE_PORT}:${GRAFANA_SERVICE_PORT}"
+
+ # OpenTelemetry Collector
+ otelcol:
+ image: ${COLLECTOR_CONTRIB_IMAGE}
+ container_name: otelcol
+ deploy:
+ resources:
+ limits:
+ memory: 200M
+ restart: unless-stopped
+ command: [ "--config=/etc/otelcol-config.yml" ]
+ volumes:
+ - ./telemetry/otelcollector/otelcol-config.yml:/etc/otelcol-config.yml
+ ports:
+ - "${OTEL_COLLECTOR_PORT_GRPC}"
+ - "${OTEL_COLLECTOR_PORT_HTTP}"
+ depends_on:
+ - jaeger
+ networks:
+ - ts-dkr-network
+ environment:
+ - ENVOY_PORT # TODO: Check
+
+ # Prometheus
+ prometheus:
+ image: ${PROMETHEUS_IMAGE}
+ container_name: prometheus
+ command:
+ - --web.console.templates=/etc/prometheus/consoles
+ - --web.console.libraries=/etc/prometheus/console_libraries
+ - --storage.tsdb.retention.time=1h
+ - --config.file=/etc/prometheus/prometheus-config.yaml
+ - --storage.tsdb.path=/prometheus
+ - --web.enable-lifecycle
+ - --web.route-prefix=/
+ - --enable-feature=exemplar-storage
+ - --enable-feature=otlp-write-receiver
+ volumes:
+ - ./telemetry/prometheus/prometheus-config.yaml:/etc/prometheus/prometheus-config.yaml
+ deploy:
+ resources:
+ limits:
+ memory: 300M
+ restart: unless-stopped
+ ports:
+ - "${PROMETHEUS_SERVICE_PORT}:${PROMETHEUS_SERVICE_PORT}"
+ networks:
+ - ts-dkr-network
+
+ # OpenSearch
+ opensearch:
+ image: ${OPENSEARCH_IMAGE}
+ container_name: opensearch
+ deploy:
+ resources:
+ limits:
+ memory: 1G
+ restart: unless-stopped
+ networks:
+ - ts-dkr-network
+ environment:
+ - cluster.name=ts-microservices-cluster
+ - node.name=ts-microservices-node
+ - bootstrap.memory_lock=true
+ - discovery.type=single-node
+ - OPENSEARCH_JAVA_OPTS=-Xms300m -Xmx300m
+ - DISABLE_INSTALL_DEMO_CONFIG=true
+ - DISABLE_SECURITY_PLUGIN=true
+ ulimits:
+ memlock:
+ soft: -1
+ hard: -1
+ nofile:
+ soft: 65536
+ hard: 65536
+ ports:
+ - "9200"