PocketBase API Engine Health & Database Storage Sentinel

id: pocketbase-api-engine-health-and-database-storage-sentinel
namespace: company.platform

description: "Continuously audits PocketBase backend engine responsiveness,
  monitors embedded SQLite database health and collection inventory, alerts via
  Slack, and prevents data layer outages."

inputs:
  - id: pocketbase_host
    type: STRING
    defaults: "localhost"
    description: "Hostname or IP address of the PocketBase backend instance."

  - id: pocketbase_port
    type: INT
    defaults: 8090
    description: "HTTP REST API port for PocketBase (default: 8090)."

  - id: max_collections_threshold
    type: INT
    defaults: 100
    description: "Maximum expected database collections before flagging unexpected
      schema growth or schema drift (default: 100)."

  - id: dry_run
    type: BOOL
    defaults: true
    description: "Safety gate: when true, audits and emits alerts without triggering
      automated diagnostic dumps or service restarts."

  - id: slack_channel
    type: STRING
    defaults: "#devops-alerts"
    description: "Target Slack channel for PocketBase engine health degradation and
      schema drift alerts."

triggers:
  - id: periodic_pocketbase_audit
    type: io.kestra.plugin.core.trigger.Schedule
    cron: "*/15 * * * *"
    disabled: true

tasks:
  - id: probe_pocketbase_health
    type: io.kestra.plugin.core.http.Request
    description: "Polls PocketBase /api/health endpoint to verify Go runtime health,
      embedded SQLite connectivity, and disk read/write capability."
    uri: "http://{{ inputs.pocketbase_host }}:{{ inputs.pocketbase_port
      }}/api/health"
    method: GET
    options:
      timeout:
        readIdleTimeout: PT15S

  - id: probe_pocketbase_collections
    type: io.kestra.plugin.core.http.Request
    description: "Queries /api/collections to inspect the database schema catalog
      and verify collection accessibility."
    uri: "http://{{ inputs.pocketbase_host }}:{{ inputs.pocketbase_port
      }}/api/collections"
    method: GET
    options:
      timeout:
        readIdleTimeout: PT15S

  - id: classify_pocketbase_status
    type: io.kestra.plugin.core.flow.Switch
    description: "Evaluates health API response payload and collection count to
      categorize status into ENGINE_UNHEALTHY, SCHEMA_DRIFT_WARNING, or
      HEALTHY."
    value: >-
      {% if outputs.probe_pocketbase_health.code != 200 or not ('"code":200' in
      outputs.probe_pocketbase_health.body) %} ENGINE_UNHEALTHY {% elif
      (fromJson(outputs.probe_pocketbase_collections.body).items ?? []) | length
      > inputs.max_collections_threshold %} SCHEMA_DRIFT_WARNING {% else %}
      HEALTHY {% endif %}
    cases:
      ENGINE_UNHEALTHY:
        - id: alert_engine_unhealthy_slack
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          description: "Dispatches critical Slack alert when PocketBase health check
            reports degraded engine or database failure."
          url: "{{ secret('SLACK_WEBHOOK_URL') }}"
          payload: |
            {
              "channel": "{{ inputs.slack_channel }}",
              "text": ":rotating_light: *PocketBase Health Degraded: Engine or SQLite Failure*",
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": ":rotating_light: *PocketBase Service Outage*\n*Host:* `http://{{ inputs.pocketbase_host }}:{{ inputs.pocketbase_port }}`\n*HTTP Code:* `{{ outputs.probe_pocketbase_health.code }}`\n*Response:* `{{ outputs.probe_pocketbase_health.body | trim }}`\n*Impact:* Client applications, real-time subscriptions, and database persistence are offline."
                  }
                }
              ]
            }

      SCHEMA_DRIFT_WARNING:
        - id: alert_schema_drift_slack
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          description: "Dispatches operational warning when collection count exceeds the
            configured baseline threshold."
          url: "{{ secret('SLACK_WEBHOOK_URL') }}"
          payload: |
            {
              "channel": "{{ inputs.slack_channel }}",
              "text": ":warning: *PocketBase Warning: Collection Inventory Threshold Exceeded*",
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": ":warning: *PocketBase Schema Drift / Collection Growth*\n*Host:* `http://{{ inputs.pocketbase_host }}:{{ inputs.pocketbase_port }}`\n*Total Collections:* `{{ (fromJson(outputs.probe_pocketbase_collections.body).items ?? []) | length }}`\n*Threshold:* `{{ inputs.max_collections_threshold }}`\n*Action:* Verify whether recent migrations created unmanaged temporary collections."
                  }
                }
              ]
            }

        - id: check_dry_run_remediation
          type: io.kestra.plugin.core.flow.If
          description: "Safeguard check ensuring diagnostic logging only triggers
            according to dry-run configuration."
          condition: "{{ inputs.dry_run == true }}"
          then:
            - id: log_dry_run_notice
              type: io.kestra.plugin.core.log.Log
              message: "Dry-run active: collection threshold breach recorded without mutating
                database schema."
          else:
            - id: log_live_remediation_intent
              type: io.kestra.plugin.core.log.Log
              message: "Live mode: collection threshold exceeded on {{ inputs.pocketbase_host
                }}. Automated schema reconciliation logged."

      HEALTHY:
        - id: log_healthy_state
          type: io.kestra.plugin.core.log.Log
          description: "Logs nominal health when PocketBase responds with code 200 and
            collections operate within baseline bounds."
          message: "PocketBase service is healthy on {{ inputs.pocketbase_host }}:{{
            inputs.pocketbase_port }}. Evaluated {{
            (fromJson(outputs.probe_pocketbase_collections.body).items ?? []) |
            length }} collections."

  - id: log_sentinel_audit_summary
    type: io.kestra.plugin.core.log.Log
    description: "Emits immutable audit record documenting PocketBase engine health
      status and execution lineage."
    message: "PocketBase sentinel evaluation complete for http://{{
      inputs.pocketbase_host }}:{{ inputs.pocketbase_port }}. Status: {{
      outputs.classify_pocketbase_status.value | trim }} | Response: {{
      outputs.probe_pocketbase_health.code }} | Execution: {{ execution.id }}"

errors:
  - id: alert_pocketbase_network_failure
    type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
    description: "Dispatches emergency Slack alert if the PocketBase container is
      down, unreachable, or network partitioned."
    url: "{{ secret('SLACK_WEBHOOK_URL') }}"
    payload: |
      {
        "channel": "{{ inputs.slack_channel }}",
        "text": ":fire: *PocketBase Network Unreachable Outage*",
        "blocks": [
          {
            "type": "section",
            "text": {
              "type": "mrkdwn",
              "text": ":fire: *PocketBase Connection Refused*\nFailed to connect to PocketBase server at `http://{{ inputs.pocketbase_host }}:{{ inputs.pocketbase_port }}`. The daemon process may have crashed, volume unmounted, or container terminated."
            }
          }
        ]
      }