Meilisearch Index Health Sentinel and Search Audit

id: meilisearch-index-health-sentinel
namespace: company.team

description: |
  Monitor Meilisearch search index health, execute document search probing, evaluate query throughput hits, and send automated alerts on search degradation.

inputs:
  - id: meilisearch_url
    type: STRING
    defaults: "http://meilisearch:7700"
    displayName: "Meilisearch Instance URL"
    description: "HTTP endpoint URL of the target Meilisearch instance."

  - id: index_name
    type: STRING
    defaults: "products"
    displayName: "Target Index Name"
    description: "Target Meilisearch index name to monitor and probe."

  - id: search_query
    type: STRING
    defaults: "laptop"
    displayName: "Search Probe Query"
    description: "Query string used to probe search availability and hit counts."

  - id: min_document_count
    type: SELECT
    defaults: "500"
    displayName: "Minimum Document Count Threshold"
    values:
      - "100"
      - "500"
      - "1000"
      - "5000"
    description: "Minimum expected document count in the index before flagging
      low-volume state."

  - id: alert_on_zero_hits
    type: SELECT
    defaults: "true"
    displayName: "Alert On Zero Hits Toggle"
    values:
      - "true"
      - "false"
    description: "Whether to trigger a Slack alert if the probe search returns zero hits."

triggers:
  - id: scheduled_check
    type: io.kestra.plugin.core.trigger.Schedule
    description: "Periodically audit Meilisearch index availability and search performance."
    cron: "0 */6 * * *"
    disabled: true
    inputs:
      meilisearch_url: "http://meilisearch:7700"
      index_name: "products"
      search_query: "laptop"
      min_document_count: "500"
      alert_on_zero_hits: "true"

tasks:
  - id: fetch_index_stats
    type: io.kestra.plugin.core.http.Request
    description: "Fetch real-time index metrics and status from Meilisearch API."
    uri: "{{ inputs.meilisearch_url }}/indexes/{{ inputs.index_name }}/stats"
    headers:
      Authorization: "Bearer {{ secret('MEILISEARCH_MASTER_KEY') }}"
    allowFailure: true

  - id: probe_search
    type: io.kestra.plugin.meilisearch.Search
    description: "Probe search execution against the target Meilisearch index."
    url: "{{ inputs.meilisearch_url }}"
    key: "{{ secret('MEILISEARCH_MASTER_KEY') }}"
    index: "{{ inputs.index_name }}"
    query: "{{ inputs.search_query }}"

  - id: evaluate_health
    type: io.kestra.plugin.core.flow.Switch
    description: "Evaluate probe hits against threshold rules to determine cluster health."
    value: "{{ (outputs.probe_search.totalHits | default(0) == 0 and
      inputs.alert_on_zero_hits == 'true') ? 'ALERT' : 'HEALTHY' }}"
    cases:
      "HEALTHY":
        - id: log_healthy
          type: io.kestra.plugin.core.log.Log
          message: "Meilisearch index '{{ inputs.index_name }}' is healthy. Probe search
            returned {{ outputs.probe_search.totalHits }} total hits."
      "ALERT":
        - id: send_alert
          type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
          url: "{{ secret('SLACK_WEBHOOK') }}"
          payload: |
            {
              "text": "ALERT: Meilisearch index search probe returned 0 hits for index '{{ inputs.index_name }}' with query '{{ inputs.search_query }}'."
            }

  - id: audit_summary
    type: io.kestra.plugin.core.log.Log
    description: "Emit final audit status summary for the Meilisearch monitoring run."
    message: "Completed Day 2 Meilisearch index health sentinel check for index '{{
      inputs.index_name }}'. Probe search hits: {{
      outputs.probe_search.totalHits }}."

errors:
  - id: notify_failure
    type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
    url: "{{ secret('SLACK_WEBHOOK') }}"
    payload: |
      {
        "text": "CRITICAL: Meilisearch index health sentinel flow execution failed for index '{{ inputs.index_name }}'."
      }