Refactor App insight integration (#39)

* Add Application Insight integration

* Add Application Insight integration

* Refactor Application Insight integration

---------

Co-authored-by: Olesia Solonko <[email protected]>

Author: solonkoolesya

Makefile

@@ -7,7 +7,7 @@ PYTHON ?= python3
 # ----- Container images -----
 FRONTEND_IMAGE_LOCAL := local/global-tsunami-risk-map-frontend:latest
 FRONTEND_IMAGE_REMOTE := ghcr.io/yejiyang/global-tsunami-risk-map-frontend:latest
-BACKEND_IMAGE_LOCAL := geopython/pygeoapi:latest
+BACKEND_IMAGE_LOCAL := geopython-api:latest
 BACKEND_IMAGE_REMOTE := ghcr.io/yejiyang/pygeoapi-w-global-tsunami-data:latest
 
 # Utility containers for data processing (avoid local installs)

docker-compose.yml

@@ -27,7 +27,7 @@ services:
 
   # Local development services
   backend-local:
-    image: geopython/pygeoapi:latest
+    image: geopython-api:latest
     container_name: backend
     ports:
       - "5000:5000"
@@ -41,7 +41,7 @@ services:
       - CONTAINER_HOST=0.0.0.0
       - CONTAINER_PORT=5000
       - PYGEOAPI_SERVER_URL=http://localhost:5000
-      - APPLICATIONINSIGHTS_CONNECTION_STRING=""
+      #- APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey=b4d987bc-1712-4026-aafb-f590fd854ab3;IngestionEndpoint=https://norwayeast-0.in.applicationinsights.azure.com/;LiveEndpoint=https://norwayeast.livediagnostics.monitor.azure.com/;ApplicationId=9fc4692c-7609-4abb-b547-49203ac14d4a
     profiles:
       - local
 

frontend/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:24-alpine as build
+FROM node:24-alpine AS build
 WORKDIR /app
 COPY package.json package-lock.json ./
 COPY build.js ./

pygeoapi/docker/appinsights_init.py

@@ -1,16 +1,20 @@
 # appinsights_init.py - Lightweight Application Insights setup for pygeoapi
+
 import os
 import logging
 from opencensus.ext.azure.log_exporter import AzureLogHandler
 from opencensus.ext.azure.trace_exporter import AzureExporter
 from opencensus.ext.flask.flask_middleware import FlaskMiddleware
 from opencensus.trace.samplers import ProbabilitySampler
 
+# Global logger for reuse
+_insights_logger = None
+
 
 def setup_app_insights(app):
     """
     Setup lightweight Application Insights for pygeoapi
-    Only tracks user interactions and basic telemetry
+    Tracks user interactions and basic telemetry
     """
     connection_string = os.environ.get('APPLICATIONINSIGHTS_CONNECTION_STRING')
 
@@ -19,19 +23,29 @@ def setup_app_insights(app):
         return
 
     try:
-        # Setup request tracking with low sampling rate for lightweight monitoring
+        print("[appinsights] Setting up Application Insights with connection string")
+
+        # Initialize OpenCensus Flask middleware
         middleware = FlaskMiddleware(
             app,
             exporter=AzureExporter(connection_string=connection_string),
-            sampler=ProbabilitySampler(rate=0.1)  # Sample 10% of requests for lightweight monitoring
+            sampler=ProbabilitySampler(rate=0.1)  # Sample 10% of requests
         )
 
-        # Setup basic logging for user interactions
-        logger = logging.getLogger(__name__)
-        logger.addHandler(AzureLogHandler(connection_string=connection_string))
+        # Setup base logging
+        logging.basicConfig(level=logging.INFO)
+        logger = logging.getLogger('pygeoapi_insights')
+
+        if not any(isinstance(h, AzureLogHandler) for h in logger.handlers):
+            handler = AzureLogHandler(connection_string=connection_string)
+            logger.addHandler(handler)
+
         logger.setLevel(logging.INFO)
 
-        # Add custom properties for better analytics
+        global _insights_logger
+        _insights_logger = logger  # Store globally for reuse in log_user_interaction
+
+        # Add request attributes to spans
         @app.before_request
         def before_request():
             from flask import request
@@ -41,27 +55,31 @@ def before_request():
             if tracer:
                 span = tracer.current_span()
                 if span:
-                    # Add custom properties for analytics
                     span.add_attribute('user_agent', request.headers.get('User-Agent', ''))
                     span.add_attribute('referrer', request.headers.get('Referer', ''))
                     span.add_attribute('api_endpoint', request.endpoint or 'unknown')
 
-        print("Application Insights configured successfully")
+        print("[appinsights] Application Insights configured successfully")
 
     except Exception as e:
-        print(f"Failed to setup Application Insights: {e}")
+        print(f"[appinsights] Failed to setup Application Insights: {e}")
+        import traceback
+        traceback.print_exc()
 
 
-# Custom logging function for user interФactions
 def log_user_interaction(action, details=None):
-    """Log user interactions for analytics"""
-    connection_string = os.environ.get('APPLICATIONINSIGHTS_CONNECTION_STRING')
-    if connection_string:
-        logger = logging.getLogger('user_analytics')
-        logger.addHandler(AzureLogHandler(connection_string=connection_string))
+    """
+    Log user interactions for analytics
+    """
+    if _insights_logger is None:
+        print("[appinsights] Telemetry not initialized, skipping interaction log")
+        return
 
-        log_data = {'action': action}
-        if details:
-            log_data.update(details)
+    log_data = {'action': action}
+    if details:
+        log_data.update(details)
 
-        logger.info(f"User interaction: {action}", extra={'custom_dimensions': log_data})
+    _insights_logger.info(
+        f"User interaction: {action}",
+        extra={'custom_dimensions': log_data}
+    )

pygeoapi/docker/init.sh

@@ -62,47 +62,48 @@ if [ -n "$APPLICATIONINSIGHTS_CONNECTION_STRING" ]; then
 
     # Create a startup script that integrates Application Insights
     cat > /tmp/start_with_insights.py << 'EOF'
-import sys
 import os
+import sys
 
-# Add the root directory to Python path to find appinsights_init
+# Add root to Python path to import appinsights_init
 sys.path.insert(0, '/')
 
 try:
-    # Import the Application Insights setup
     import appinsights_init
-    print("[init] Application Insights module loaded successfully")
+    print("[start_with_insights] Application Insights module loaded")
 
-    # Import pygeoapi app
+    # Import prebuilt Flask app instance
     from pygeoapi.flask_app import APP as app
+    print("[start_with_insights] Flask app imported successfully")
 
-    # Setup Application Insights
+    # Setup Application Insights telemetry
     appinsights_init.setup_app_insights(app)
-    print("[init] Application Insights integrated successfully")
+    print("[start_with_insights] Application Insights integrated")
 
 except ImportError as e:
-    print(f"[init] Application Insights setup skipped: {e}")
-    # Continue without Application Insights
-    pass
+    print(f"[start_with_insights] ImportError: {e}")
+    sys.exit(1)
+
 except Exception as e:
-    print(f"[init] Application Insights setup failed: {e}")
-    # Continue without Application Insights
-    pass
+    print(f"[start_with_insights] Error during telemetry setup: {e}")
+    import traceback
+    traceback.print_exc()
+
+# Run the app (development mode only)
+if __name__ == '__main__':
+    print("[start_with_insights] Starting Flask app")
+    app.run(host='0.0.0.0', port=5000)
 
-print("[init] Application Insights setup completed")
 EOF
 
     # Execute the Application Insights setup (but don't start the app yet)
     python3 /tmp/start_with_insights.py
 
 else
     echo "$(get_timestamp) [init] Starting pygeoapi service without Application Insights"
-    # Still need to generate OpenAPI document
     echo "$(get_timestamp) [init] Generating OpenAPI document"
     pygeoapi openapi generate /pygeoapi/local.config.yml --output-file /tmp/openapi.yml
+    # Start the pygeoapi service
+    echo "$(get_timestamp) [init] Starting pygeoapi service"
+    exec /entrypoint.sh "$@"
 fi
-
-
-# Start the pygeoapi service
-echo "$(get_timestamp) [init] Starting pygeoapi service"
-exec /entrypoint.sh "$@"