chore: add OTEL (#109)

.env.example

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 PNED G.I.E.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
+OTEL_SDK_DISABLED=true
+OTEL_EXPORTER_OTLP_ENDPOINT=http://openobserve-dev-env.ss-dev.lnds.internal:4319

.gitignore

@@ -77,3 +77,5 @@ Temporary Items
 __pycache__
 
 *.egg-info
+
+venv

ckanext/gdi_userportal/plugin.py

@@ -13,7 +13,34 @@
 from ckanext.gdi_userportal.logic.auth.get import config_option_show
 from ckanext.gdi_userportal.validation import scheming_isodatetime_flex
 
-from ckan import model
+from opentelemetry import metrics
+from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
+from opentelemetry.sdk.resources import SERVICE_NAME, Resource
+from opentelemetry.instrumentation.flask import FlaskInstrumentor
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def setup_opentelemetry():
+    resource = Resource(attributes={SERVICE_NAME: "ckan"})
+
+    traceProvider = TracerProvider(resource=resource)
+    processor = BatchSpanProcessor(OTLPSpanExporter())
+    traceProvider.add_span_processor(processor)
+    trace.set_tracer_provider(traceProvider)
+
+    reader = PeriodicExportingMetricReader(OTLPMetricExporter())
+    provider = MeterProvider(resource=resource, metric_readers=[reader])
+    metrics.set_meter_provider(provider)
 
 
 class GdiUserPortalPlugin(plugins.SingletonPlugin):
@@ -23,6 +50,8 @@ class GdiUserPortalPlugin(plugins.SingletonPlugin):
     plugins.implements(plugins.IActions)
     plugins.implements(plugins.IPackageController)
     plugins.implements(plugins.IValidators)
+    plugins.implements(plugins.IMiddleware, inherit=True)
+    plugins.implements(plugins.IConfigurable, inherit=True)
 
     _dcatap_fields_to_normalize = [
         "access_rights",
@@ -147,3 +176,12 @@ def update_facet_titles(self, facet_titles):
 
     def get_validators(self):
         return {"scheming_isodatetime_flex": scheming_isodatetime_flex}
+
+    # IConfigurable
+    def configure(self, config):
+        setup_opentelemetry()
+
+    # IMiddleware
+    def make_middleware(self, app, config):
+        FlaskInstrumentor().instrument_app(app)
+        return app

requirements.txt

@@ -2,6 +2,11 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-# CKAN requires 2.9.0, we are slightly less picky
-python-dateutil >= 2.8.1
-pytz
+python-dateutil==2.9.0.post0
+pytz==2024.2
+opentelemetry-api==1.27.0
+opentelemetry-sdk==1.27.0
+opentelemetry-instrumentation==0.48b0
+opentelemetry-instrumentation-flask==0.48b0
+opentelemetry-exporter-otlp-proto-http==1.27.0
+ckantoolkit==0.0.7