Add example of OpenTelemetry in Optuna Dashboard

Author: c-bata

dashboard/opentelemetry/docker-compose.yml

@@ -0,0 +1,24 @@
+services:
+  grafana:
+    image: grafana/grafana:latest
+    ports:
+      - "127.0.0.1:13000:3000"
+  prometheus:
+    image: prom/prometheus
+    volumes:
+      - ./prometheus.yml:/etc/prometheus.yml
+    command:
+      - "--config.file=/etc/prometheus.yml"
+    ports:
+      - "127.0.0.19090:9090"
+  otel-collector:
+    image: ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:latest
+    volumes:
+      - ./otel-collector-config.yml:/etc/otel-collector-config.yml
+    command: ["--config=/etc/otel-collector-config.yml"]
+    ports:
+      - "127.0.0.1:8888:8888" # Prometheus metrics exposed by the collector
+      - "127.0.0.1:8889:8889" # Prometheus exporter metrics
+      - "127.0.0.1:13133:13133" # health_check extension
+      - "127.0.0.1:4317:4317" # OTLP gRPC receiver
+      - "127.0.0.1:4318:4318" # OTLP HTTP receiver

dashboard/opentelemetry/main.py

@@ -0,0 +1,57 @@
+import wsgiref.simple_server
+
+from opentelemetry import metrics
+from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
+from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
+from opentelemetry.instrumentation.wsgi import OpenTelemetryMiddleware
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
+from opentelemetry.sdk.resources import Resource
+from optuna.storages import RDBStorage
+import optuna_dashboard
+
+
+SQLALCHEMY_URL = "sqlite:///db.sqlite3"
+OTEL_COLLECTOR_ENDPOINT = "http://127.0.0.1:4318/v1/metrics"
+
+
+def main() -> None:
+    resource = Resource.create({"service.name": "optuna-dashboard"})
+    readers = [
+        PeriodicExportingMetricReader(
+            OTLPMetricExporter(endpoint=OTEL_COLLECTOR_ENDPOINT),
+            export_interval_millis=1000,
+            export_timeout_millis=5000,
+        ),
+    ]
+    metrics.set_meter_provider(MeterProvider(resource=resource, metric_readers=readers))
+
+    # If you want to use PrometheusMetricReader, uncomment the following lines
+    # from prometheus_client import start_http_server
+    # from opentelemetry.exporter.prometheus import PrometheusMetricReader
+    # print("Metrics endpoint: http://127.0.0.1:9464/metrics")
+    # start_http_server(port=9464, addr="127.0.0.1")
+    # readers.append(PrometheusMetricReader("optuna_dashboard"))
+
+    # If you want to see metrics in the console, uncomment the following line
+    # from opentelemetry.sdk.metrics.export import ConsoleMetricExporter
+    # readers.append(PeriodicExportingMetricReader(ConsoleMetricExporter()))
+
+    # Enable opentelemetry-instrumentation-sqlalchemy
+    storage = RDBStorage(SQLALCHEMY_URL, skip_compatibility_check=True, skip_table_creation=True)
+    SQLAlchemyInstrumentor().instrument(
+        engine=storage.engine,
+        meter_provider=metrics.get_meter_provider(),
+    )
+
+    # Enable opentelemetry-instrumentation-wsgi
+    app = optuna_dashboard.wsgi(storage=storage)
+    app = OpenTelemetryMiddleware(app, meter_provider=metrics.get_meter_provider())
+
+    # Start Optuna Dashboard
+    with wsgiref.simple_server.make_server("127.0.0.1", 8080, app) as httpd:
+        httpd.serve_forever()
+
+
+if __name__ == "__main__":
+    main()

dashboard/opentelemetry/otel-collector-config.yml

@@ -0,0 +1,25 @@
+receivers:
+  otlp:
+    protocols:
+      http:
+        endpoint: otel-collector:4318
+        cors:
+          allowed_origins:
+            - "http://*"
+            - "https://*"
+processors:
+  batch:
+exporters:
+  prometheus:
+    endpoint: "0.0.0.0:8889"
+  debug:
+    verbosity: detailed
+extensions:
+  health_check:
+service:
+  extensions: ["health_check"]
+  pipelines:
+    metrics:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [prometheus, debug]

dashboard/opentelemetry/prometheus.yml

@@ -0,0 +1,7 @@
+global:
+  scrape_interval: 15s
+scrape_configs:
+  - job_name: "prometheus"
+    scrape_interval: 5s
+    static_configs:
+      - targets: ["otel-collector:8889"]

dashboard/opentelemetry/requirements.txt

@@ -0,0 +1,7 @@
+optuna-dashboard
+opentelemetry-api>=1.34.1
+opentelemetry-exporter-otlp>=1.34.1
+opentelemetry-exporter-prometheus>=0.55b1
+opentelemetry-sdk>=1.34.1
+opentelemetry-instrumentation-wsgi
+opentelemetry-instrumentation-sqlalchemy