Elasticsearch

The Elasticsearch check connects to an Elasticsearch database, runs a query, and verifies the result count.

OpenSearch

To connect to OpenSearch, use the opensearch field instead of elasticsearch.

elasticsearch.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
  name: elasticsearch-pass
spec:
  schedule: "@every 5m"
  elasticsearch:
    - url: http://elasticsearch.canaries.svc.cluster.local:9200
      description: Elasticsearch checker
      index: index
      query: |
        {
          "query": {
            "term": {
              "system.role": "api"
            }
          }
        }
      results: 1
      name: elasticsearch_pass

Field	Description	Scheme
name*	Name of the check, must be unique within the canary	string
connection	Connection reference or URL to use. Inline username and password can supply credentials when the check supports them	Connection
index	Index to query
password		EnvVar
query	Query that needs to be executed on the server	JSON
results	Expected hit count. Defaults to 0. The check fails unless the hit count equals this value.	integer
url	Elasticsearch URL. Required unless connection supplies the URL
username		EnvVar
dependsOn	Checks that must complete before this check runs	[]string
description	Description for the check	string
display	Expression to change the formatting of the display	Expression
icon	Icon for overwriting default icon on the dashboard	Icon
labels	Labels for check	[map[string]string]
markFailOnEmpty	If a transformation or datasource returns empty results, the check should fail	boolean
metrics	Metrics to export from	[]Metrics
namespace	Namespace to insert the check result into when it differs from the canary namespace	string
relationships	Relationships that link check results to components or configs	Relationship
test	Evaluate whether a check is healthy	Expression
transform	Transform data from a check into multiple individual checks	Expression
transformDeleteStrategy	Status to apply to transformed checks when the source check no longer returns them	string