NocoDB Database Platform Health, Storage Engine, and Project Sentinel

id: nocodb-database-health-and-project-sentinel
namespace: company.team

description: |
  Continuously monitors NocoDB no-code database and smart spreadsheet platforms by probing core application health endpoints, validating backend SQL database connection pool responsiveness (PostgreSQL/MySQL/SQLite), auditing base project metadata accessibility, classifying operational posture, routing real-time Slack incident alerts, and logging compliance audit records.

inputs:
  - id: nocodb_host
    type: STRING
    displayName: NocoDB Host
    description: Hostname or IP address of the NocoDB instance reachable by the
      Kestra worker.
    defaults: "localhost"

  - id: nocodb_port
    type: INT
    displayName: NocoDB Port
    description: HTTP port of the NocoDB service (defaults to 8080).
    defaults: 8080

  - id: nocodb_scheme
    type: STRING
    displayName: Protocol Scheme
    description: URI protocol scheme (http or https).
    defaults: "http"

  - id: expected_status
    type: STRING
    displayName: Expected Health Status
    description: Expected string value of the status attribute in NocoDB
      /api/v1/health response JSON (defaults to OK).
    defaults: "OK"

tasks:
  - id: probe_health_endpoint
    type: io.kestra.plugin.core.http.Request
    description: Queries NocoDB /api/v1/health to audit server liveness and verify
      that primary metadata database connection pools are operational.
    uri: "{{ inputs.nocodb_scheme }}://{{ inputs.nocodb_host }}:{{
      inputs.nocodb_port }}/api/v1/health"
    method: GET
    headers:
      Accept: "application/json"
    options:
      allowFailed: true
    allowFailure: true

  - id: probe_version_endpoint
    type: io.kestra.plugin.core.http.Request
    description: Queries NocoDB /api/v1/version to verify web server responsiveness
      and deployment release consistency.
    uri: "{{ inputs.nocodb_scheme }}://{{ inputs.nocodb_host }}:{{
      inputs.nocodb_port }}/api/v1/version"
    method: GET
    headers:
      Accept: "application/json"
    options:
      allowFailed: true
    allowFailure: true

  - id: probe_project_metadata
    type: io.kestra.plugin.core.http.Request
    description: Queries NocoDB /api/v1/db/meta/projects to verify that base project
      schemas and connected SQL data sources can be queried via API token.
    uri: "{{ inputs.nocodb_scheme }}://{{ inputs.nocodb_host }}:{{
      inputs.nocodb_port }}/api/v1/db/meta/projects?limit=10"
    method: GET
    headers:
      Accept: "application/json"
      xc-token: "{{ secret('NOCODB_API_TOKEN') }}"
    options:
      allowFailed: true
    allowFailure: true

  - id: classify_nocodb_posture
    type: io.kestra.plugin.core.debug.Return
    description: Evaluates HTTP status codes across health, version, and project
      metadata probes to classify NocoDB operational posture.
    format: |
      {{ outputs.probe_health_endpoint.code is not defined or outputs.probe_version_endpoint.code is not defined ? 'INSTANCE_UNREACHABLE' : (outputs.probe_health_endpoint.code != 200 or not (((outputs.probe_health_endpoint.body | json | jq('.status') | first) ?? '') == inputs.expected_status) ? 'DATABASE_STORAGE_DEGRADED' : (outputs.probe_version_endpoint.code != 200 ? 'SERVER_PROCESS_UNHEALTHY' : (outputs.probe_project_metadata.code != 200 ? 'PROJECT_METADATA_UNREADY' : 'HEALTHY_COMPLIANT'))) }}

  - id: route_by_posture
    type: io.kestra.plugin.core.flow.Switch
    description: Routes alerts and logs based on the classified NocoDB operational posture.
    value: "{{ outputs.classify_nocodb_posture.value }}"
    cases:
      "HEALTHY_COMPLIANT":
        - id: log_healthy
          type: io.kestra.plugin.core.log.Log
          message: "NocoDB instance at {{ inputs.nocodb_scheme }}://{{ inputs.nocodb_host
            }}:{{ inputs.nocodb_port }} is HEALTHY_COMPLIANT. /api/v1/health
            status: {{ outputs.probe_health_endpoint.code }} ({{
            outputs.probe_health_endpoint.body | json | jq('.status') | first
            }}). Version: {{ outputs.probe_version_endpoint.body | json |
            jq('.version') | first ?? 'N/A' }}. Project metadata: HTTP {{
            outputs.probe_project_metadata.code }}."

      "DATABASE_STORAGE_DEGRADED":
        - id: alert_database_degraded_slack
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          url: "{{ secret('SLACK_WEBHOOK_URL') }}"
          payload: |
            {{ {"text": "NocoDB Sentinel CRITICAL ALERT: Database backend degraded on " ~ inputs.nocodb_host ~ ":" ~ inputs.nocodb_port ~ "! /api/v1/health returned HTTP " ~ (outputs.probe_health_endpoint.code ?? 'NONE') ~ " (payload: " ~ (outputs.probe_health_endpoint.body ?? 'EMPTY') ~ "). PostgreSQL, MySQL, or SQLite connection pool failed. User spreadsheet updates and API mutations blocked! Execution: " ~ execution.id ~ "."} | toJson }}

        - id: log_database_degraded
          type: io.kestra.plugin.core.log.Log
          message: "CRITICAL: NocoDB /api/v1/health returned non-200 or unready status: {{
            outputs.probe_health_endpoint.code }}."

      "PROJECT_METADATA_UNREADY":
        - id: alert_project_metadata_slack
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          url: "{{ secret('SLACK_WEBHOOK_URL') }}"
          payload: |
            {{ {"text": "NocoDB Sentinel WARNING: Project metadata API unready on " ~ inputs.nocodb_host ~ ":" ~ inputs.nocodb_port ~ "! /api/v1/db/meta/projects returned HTTP " ~ (outputs.probe_project_metadata.code ?? 'NONE') ~ ". Check NOCODB_API_TOKEN permissions or schema cache sync. Execution: " ~ execution.id ~ "."} | toJson }}

        - id: log_project_metadata
          type: io.kestra.plugin.core.log.Log
          message: "WARNING: NocoDB /api/v1/db/meta/projects returned non-200 code: {{
            outputs.probe_project_metadata.code }}."

      "SERVER_PROCESS_UNHEALTHY":
        - id: alert_server_unhealthy_slack
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          url: "{{ secret('SLACK_WEBHOOK_URL') }}"
          payload: |
            {{ {"text": "NocoDB Sentinel WARNING: Server process unhealthy on " ~ inputs.nocodb_host ~ ":" ~ inputs.nocodb_port ~ "! /api/v1/version returned HTTP " ~ (outputs.probe_version_endpoint.code ?? 'NONE') ~ ". Node.js application process is failing requests. Execution: " ~ execution.id ~ "."} | toJson }}

        - id: log_server_unhealthy
          type: io.kestra.plugin.core.log.Log
          message: "WARNING: NocoDB /api/v1/version returned non-200 code: {{
            outputs.probe_version_endpoint.code }}."

      "INSTANCE_UNREACHABLE":
        - id: alert_unreachable_slack
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          url: "{{ secret('SLACK_WEBHOOK_URL') }}"
          payload: |
            {{ {"text": "NocoDB Sentinel OUTAGE: Cannot reach NocoDB instance at " ~ inputs.nocodb_scheme ~ "://" ~ inputs.nocodb_host ~ ":" ~ inputs.nocodb_port ~ ". Container offline, network partitioned, or reverse-proxy connection refused. Execution: " ~ execution.id ~ "."} | toJson }}

        - id: log_unreachable
          type: io.kestra.plugin.core.log.Log
          message: "OUTAGE: NocoDB instance unreachable at {{ inputs.nocodb_scheme }}://{{
            inputs.nocodb_host }}:{{ inputs.nocodb_port }}."

  - id: audit_summary
    type: io.kestra.plugin.core.output.OutputValues
    description: Exports structured telemetry attributes and endpoint verification
      metrics for compliance audit reporting.
    values:
      target_instance: "{{ inputs.nocodb_scheme }}://{{ inputs.nocodb_host }}:{{
        inputs.nocodb_port }}"
      health_http_code: "{{ outputs.probe_health_endpoint.code ?? 0 }}"
      health_payload_status: "{{ outputs.probe_health_endpoint.body | json |
        jq('.status') | first ?? 'NONE' }}"
      version_http_code: "{{ outputs.probe_version_endpoint.code ?? 0 }}"
      server_version: "{{ outputs.probe_version_endpoint.body | json | jq('.version')
        | first ?? 'N/A' }}"
      project_meta_code: "{{ outputs.probe_project_metadata.code ?? 0 }}"
      operational_posture: "{{ outputs.classify_nocodb_posture.value }}"

errors:
  - id: alert_flow_failure
    type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
    description: Alerts on unexpected workflow runtime execution failure.
    url: "{{ secret('SLACK_WEBHOOK_URL') }}"
    payload: |
      {{ {"text": "NocoDB Sentinel workflow failed unexpectedly during execution " ~ execution.id ~ " in namespace " ~ flow.namespace ~ "."} | toJson }}

triggers:
  - id: hourly_canary
    type: io.kestra.plugin.core.trigger.Schedule
    description: Executes automated NocoDB health and database connectivity audit at
      the top of every hour. Shipped disabled.
    cron: "0 * * * *"
    disabled: true
    inputs:
      nocodb_host: "localhost"
      nocodb_port: 8080
      nocodb_scheme: "http"
      expected_status: "OK"