====== Azure Open AI Chatbot Deployment Checklist ======

===== ✅ Azure OpenAI Chatbot Deployment Checklist =====

==== 1. Local Build and Testing ====

  * Bot code tested locally with Bot Framework Emulator.
  * Environment variables for ''AZURE_OPENAI_ENDPOINT'', ''DEPLOYMENT_ID'', and ''API_KEY'' correctly referenced.
  * Docker container runs successfully on ''localhost:3978''.

==== 2. Azure Resources Setup ====

  * Resource Group created or selected.
  * Azure Container Registry (ACR) created and admin access enabled (if not using managed identity).
  * Azure OpenAI Service created with deployed model (e.g., gpt-35-turbo).

==== 3. Docker Image Build and Push ====

  * Docker image built with ''docker build -t <image> .''.
  * Docker image tagged with ACR address.
  * Docker image pushed to ACR.

==== 4. Deployment Parameters ====

  * Parameter values prepared, either inline or in ''containerapp-params.json''.
  * Verified API Key, OpenAI endpoint, and deployment ID.
  * Verified ACR server, username, and password (if required).

==== 5. Bicep Deployment ====

  * Bicep template validated with ''az bicep build''.
  * Deployment executed with either inline parameters or parameter file.
  * Verified Container App is running in Azure Portal.

==== 6. Testing After Deployment ====

  * Verified public URL responds (default port 3978).
  * Connected Bot Framework Emulator to Container App URL.
  * Tested conversation flow using OpenAI backend.

==== 7. Security and Scaling ====

  * Confirmed ACR access is secured.
  * Configured auto-scaling (if needed).
  * Applied secure ingress settings (HTTPS, auth if needed).

==== 8. Observability ====

  * Log Analytics Workspace attached.
  * Application logging enabled and verified in Azure Monitor.

==== 9. Log Analytics and Monitoring ====

  * **Log Analytics Workspace** created and linked to Container App Environment.
  * **App Logs** verified in **Log Analytics > Logs** with queries like:

<code ->
AppContainerAppConsoleLogs_CL \\
| where ContainerAppName_s == "<your-container-app-name>"\\
| sort by TimeGenerated desc
</code>

  * **Metrics monitoring** verified (CPU, Memory, Request Count).

----

==== 10. Alerts Setup ====

  * **Alert Rule for CPU Usage**
    * Example: Alert if CPU exceeds 80% for 5 minutes.
  * **Alert Rule for Memory Usage**
    * Example: Alert if Memory exceeds 75% for 5 minutes.
  * **Alert Rule for HTTP 500 Errors**
    * Example: Query for failed requests in Log Analytics.

=== Example KQL for HTTP 500 Errors: ===

<code ->
AppContainerAppConsoleLogs_CL
| where Log_s contains "500"
| summarize Count = count() by bin(TimeGenerated, 5m)
</code>

=== Example Alert Setup Steps: ===

  - Go to **Azure Monitor > Alerts**.
  - Click **+ New Alert Rule**.
  - **Select Resource**: Your Container App or Log Analytics Workspace.
  - **Condition**: Add a metric or log query condition.
  - **Action Group**: Create or select action groups (email, Teams, webhook, etc.).
  - **Alert Details**: Name and severity.

  * **Notification Channels Configured**
    * Email
    * Teams
    * Webhook (optional)

===== Bicep Definitions To Create Alerts =====

<code ->
param containerAppResourceId string
param logAnalyticsWorkspaceId string
param actionGroupId string

@description('Create CPU High Usage Alert')
resource cpuAlert 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  name: 'cpu-high-usage'
  location: 'global'
  properties: {
    description: 'Alert when CPU usage exceeds 80%'
    severity: 3
    enabled: true
    scopes: [containerAppResourceId]
    evaluationFrequency: 'PT1M'
    windowSize: 'PT5M'
    criteria: {
      allOf: [
        {
          metricName: 'cpuUsagePercentage'
          metricNamespace: 'Microsoft.App/containerApps'
          operator: 'GreaterThan'
          threshold: 80
          timeAggregation: 'Average'
        }
      ]
    }
    actions: [
      {
        actionGroupId: actionGroupId
      }
    ]
  }
}

@description('Create Memory High Usage Alert')
resource memoryAlert 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  name: 'memory-high-usage'
  location: 'global'
  properties: {
    description: 'Alert when memory usage exceeds 75%'
    severity: 3
    enabled: true
    scopes: [containerAppResourceId]
    evaluationFrequency: 'PT1M'
    windowSize: 'PT5M'
    criteria: {
      allOf: [
        {
          metricName: 'memoryWorkingSetBytes'
          metricNamespace: 'Microsoft.App/containerApps'
          operator: 'GreaterThan'
          threshold: 75
          timeAggregation: 'Average'
        }
      ]
    }
    actions: [
      {
        actionGroupId: actionGroupId
      }
    ]
  }
}
</code>

==== KQL Code for HTTP 500 Errors ====

<code ->
AppContainerAppConsoleLogs_CL
| where Log_s contains "500"
| summarize Count=count() by bin(TimeGenerated, 5m)
| where Count > 0
</code>

==== Bicep Template for Log Query Alert ====

<code ->
param logAnalyticsWorkspaceId string
param actionGroupId string

@description('Create HTTP 500 Error Log Alert')
resource errorLogAlert 'Microsoft.Insights/scheduledQueryRules@2021-08-01' = {
  name: 'http-500-error-alert'
  location: 'global'
  properties: {
    description: 'Alert when HTTP 500 errors are detected in logs'
    enabled: true
    source: {
      query: '''
        AppContainerAppConsoleLogs_CL
        | where Log_s contains "500"
        | summarize Count=count() by bin(TimeGenerated, 5m)
        | where Count > 0
      '''
      dataSourceId: logAnalyticsWorkspaceId
      queryType: 'ResultCount'
    }
    schedule: {
      frequencyInMinutes: 5
      timeWindowInMinutes: 5
    }
    action: {
      severity: 3
      trigger: {
        thresholdOperator: 'GreaterThan'
        threshold: 0
      }
      actions: [
        {
          actionGroupId: actionGroupId
        }
      ]
    }
  }
}
</code>

==== Deployment Example ====

<code ->
az deployment group create \
  --resource-group MyResourceGroup \
  --template-file log-alert.bicep \
  --parameters \
    logAnalyticsWorkspaceId="/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.OperationalInsights/workspaces/<workspace-name>" \
    actionGroupId="/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.Insights/actionGroups/NotifyTeam"
</code>

===== ✅ What This Provides =====

  * **Detection of HTTP 500 Errors** in Console Logs.
  * **Trigger Every 5 Minutes** if any are found.
  * **Send Notifications via Action Group**.

Complete Bicep Bundle

<code ->
param containerAppResourceId string
param logAnalyticsWorkspaceId string
param actionGroupId string

// CPU High Usage Alert
resource cpuAlert 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  name: 'cpu-high-usage'
  location: 'global'
  properties: {
    description: 'Alert when CPU usage exceeds 80%'
    severity: 3
    enabled: true
    scopes: [containerAppResourceId]
    evaluationFrequency: 'PT1M'
    windowSize: 'PT5M'
    criteria: {
      allOf: [
        {
          metricName: 'cpuUsagePercentage'
          metricNamespace: 'Microsoft.App/containerApps'
          operator: 'GreaterThan'
          threshold: 80
          timeAggregation: 'Average'
        }
      ]
    }
    actions: [
      {
        actionGroupId: actionGroupId
      }
    ]
  }
}

// Memory High Usage Alert
resource memoryAlert 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  name: 'memory-high-usage'
  location: 'global'
  properties: {
    description: 'Alert when memory usage exceeds 75%'
    severity: 3
    enabled: true
    scopes: [containerAppResourceId]
    evaluationFrequency: 'PT1M'
    windowSize: 'PT5M'
    criteria: {
      allOf: [
        {
          metricName: 'memoryWorkingSetBytes'
          metricNamespace: 'Microsoft.App/containerApps'
          operator: 'GreaterThan'
          threshold: 75
          timeAggregation: 'Average'
        }
      ]
    }
    actions: [
      {
        actionGroupId: actionGroupId
      }
    ]
  }
}

// HTTP 500 Log Alert
resource errorLogAlert 'Microsoft.Insights/scheduledQueryRules@2021-08-01' = {
  name: 'http-500-error-alert'
  location: 'global'
  properties: {
    description: 'Alert when HTTP 500 errors are detected in logs'
    enabled: true
    source: {
      query: '''
        AppContainerAppConsoleLogs_CL
        | where Log_s contains "500"
        | summarize Count=count() by bin(TimeGenerated, 5m)
        | where Count > 0
      '''
      dataSourceId: logAnalyticsWorkspaceId
      queryType: 'ResultCount'
    }
    schedule: {
      frequencyInMinutes: 5
      timeWindowInMinutes: 5
    }
    action: {
      severity: 3
      trigger: {
        thresholdOperator: 'GreaterThan'
        threshold: 0
      }
      actions: [
        {
          actionGroupId: actionGroupId
        }
      ]
    }
  }
}
</code>

Deployment Command Example
<code>
az deployment group create \
  --resource-group MyResourceGroup \
  --template-file complete-alerts.bicep \
  --parameters \
    containerAppResourceId="/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.App/containerApps/<app-name>" \
    logAnalyticsWorkspaceId="/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.OperationalInsights/workspaces/<workspace-name>" \
    actionGroupId="/subscriptions/<sub-id>/resourceGroups/<rg>/providers/Microsoft.Insights/actionGroups/NotifyTeam"
</code>