feat: enable sending of logs to Azure Monitor

Author: afeld

benefits/logging.py

@@ -1,5 +1,8 @@
+import os
+
+
 def get_config(level):
-    return {
+    config = {
         "version": 1,
         "disable_existing_loggers": False,
         "formatters": {
@@ -10,19 +13,38 @@ def get_config(level):
             },
         },
         "handlers": {
-            "default": {
+            "console": {
                 "class": "logging.StreamHandler",
                 "formatter": "default",
             },
         },
         "root": {
-            "handlers": ["default"],
+            "handlers": ["console"],
             "level": level,
         },
         "loggers": {
             "django": {
-                "handlers": ["default"],
+                "handlers": ["console"],
                 "propagate": False,
             },
         },
     }
+
+    if "APPLICATIONINSIGHTS_CONNECTION_STRING" in os.environ:
+        # enable Azure Insights logging
+
+        # https://docs.microsoft.com/en-us/azure/azure-monitor/app/opencensus-python#configure-logging-for-django-applications
+        config["handlers"]["azure"] = {
+            "class": "opencensus.ext.azure.log_exporter.AzureLogHandler",
+            # send all logs
+            "logging_sampling_rate": 1.0,
+        }
+
+        # create custom logger
+        # https://github.com/census-instrumentation/opencensus-python/issues/1130#issuecomment-1161898856
+        config["loggers"]["azure"] = {
+            "handlers": ["azure"],
+            "level": "INFO",
+        }
+
+    return config

docs/configuration/environment-variables.md

@@ -149,3 +149,13 @@ devcontainer, check the [`DJANGO_LOCAL_PORT`](#django_local_port).
 
 [deployment]: ../deployment/README.md
 [getting-started_create-env]: ../getting-started/README.md#create-an-environment-file
+
+## Azure
+
+### `APPLICATIONINSIGHTS_CONNECTION_STRING`
+
+!!! tldr "Azure docs"
+
+    [Azure Monitor connection strings](https://docs.microsoft.com/en-us/azure/azure-monitor/app/sdk-connection-string)
+
+Enables [log collection](../../deployment/infrastructure/#logs). Set the value in quotes, e.g. `APPLICATIONINSIGHTS_CONNECTION_STRING="InstrumentationKey=…"`.

docs/deployment/infrastructure.md

@@ -63,6 +63,17 @@ flowchart LR
 
 We have [ping tests](https://docs.microsoft.com/en-us/azure/azure-monitor/app/monitor-web-app-availability) set up to notify about availability of the dev, test, and prod deployments. Alerts go to [#benefits-notify](https://cal-itp.slack.com/archives/C022HHSEE3F).
 
+## Logs
+
+We send application logs to [Azure Monitor Logs](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/data-platform-logs). To find them:
+
+1. [Open Application Insights.](https://portal.azure.com/#view/HubsExtension/BrowseResource/resourceType/microsoft.insights%2Fcomponents)
+1. Click the resource corresponding to the environment.
+1. In the navigation, under `Monitoring`, click `Logs`.
+1. In the Query Editor, type `traces`, and click `Run`.
+
+You should see recent log output. Note [there is some latency](https://docs.microsoft.com/en-us/azure/azure-monitor/logs/data-ingestion-time).
+
 ## Making changes
 
 1. Get access to the Azure account through the DevSecOps team.

requirements.txt

@@ -3,5 +3,6 @@ Django==3.2.13
 django-csp==3.7
 git+https://github.com/cal-itp/eligibility-api#egg=eligibility_api
 gunicorn==20.1.0
+opencensus-ext-azure==1.1.4
 requests==2.28.0
 six==1.16.0