Skip to content


The Elasticsearch plugin can be used to retrieve logs from a configured Elasticsearch instance. You can specify a query, which is used to retireve all documents from Elasticsearch. You can also select a list of fields, to display the results in a table. From this table you can also select a single document to view the complete json representation of this document.





The following config can be used to grant kobs access to a Elasticsearch instance running on and is protected with basic authentication. The credentials will be provided by the environment variables ES_USERANME and ES_PASSWORD.

    - name: Elasticsearch
      description: Elasticsearch can be used for the logs of your application.
      username: ${ES_USERNAME}
      password: ${ES_PASSWORD}
Field Type Description Required
name string Name of the Elasticsearch instance. Yes
displayName string Name of the Elasticsearch as it is shown in the UI. Yes
description string Description of the Elasticsearch instance. No
home boolean When this is true the plugin will be added to the home page. No
address string Address of the Elasticsearch instance. Yes
username string Username to access an Elasticsearch instance via basic authentication. No
password string Password to access an Elasticsearch instance via basic authentication. No
token string Token to access an Elasticsearch instance via token based authentication. No


The following options can be used for a panel with the Elasticsearch plugin:

Field Type Description Required
showChart boolean If this is true the chart with the distribution of the Documents over the selected time range will be shown No
queries []Query A list of Elasticsearch queries, which can be selected by the user. Yes


Field Type Description Required
name string A name for the Elasticsearch query, which is displayed in the select box. Yes
query string The Elasticsearch query. We are using the Query String Syntax for Elasticsearch. Yes
fields []string A list of fields to display in the results table. If this field is omitted, the whole document is displayed in the results table. No
kind: Dashboard
    - name: namespace
      description: The workload namespace
    - name: app
      description: The workloads app label
    - size: -1
        - title: Istio Logs
          colSpan: 12
            name: elasticsearch
              showChart: true
                - name: Istio Logs
                  query: "kubernetes.namespace: {% .namespace %} AND {% .app %} AND istio-proxy AND _exists_: content.method"
                    - ""
                    - "content.authority"
                    - "content.route_name"
                    - "content.protocol"
                    - "content.method"
                    - "content.path"
                    - "content.response_code"
                    - "content.upstream_service_time"
                    - "content.bytes_received"
                    - "content.bytes_sent"

Query String Syntax

The Elasticsearch plugins uses the query string syntax for filtering log lines.

Field Names

You can specify fields to search in the query syntax:

  • where the status field contains active
  • where the title field contains quick or brown
title:(quick OR brown)
  • where the author field contains the exact phrase "john smith"
author:"John Smith"
  • where the first name field contains Alice (note how we need to escape the space with a backslash)
first\ name:Alice
  • where any of the fields book.title, book.content or contains quick or brown (note how we need to escape the * with a backslash):
book.\*:(quick OR brown)
  • where the field title has any non-null value:


Wildcard searches can be run on individual terms, using ? to replace a single character, and * to replace zero or more characters:

qu?ck bro*

Regular Expressions

Regular expression patterns can be embedded in the query string by wrapping them in forward-slashes ("/"):



We can search for terms that are similar to, but not exactly like our search terms, using the "fuzzy" operator:

quikc~ brwn~ foks~


Ranges can be specified for date, numeric or string fields. Inclusive ranges are specified with square brackets [min TO max] and exclusive ranges with curly brackets {min TO max}.

  • All days in 2012:
date:[2012-01-01 TO 2012-12-31]
  • Numbers 1..5
count:[1 TO 5]
  • Tags between alpha and omega, excluding alpha and omega:
tag:{alpha TO omega}
  • Numbers from 10 upwards
count:[10 TO *]
  • Dates before 2012
date:{* TO 2012-01-01}

Boolean operators

By default, all terms are optional, as long as one term matches. A search for foo bar baz will find any document that contains one or more of foo or bar or baz. We have already discussed the default_operator above which allows you to force all terms to be required, but there are also boolean operators which can be used in the query string itself to provide more control.

The preferred operators are + (this term must be present) and - (this term must not be present). All other terms are optional. For example, this query:

quick brown +fox -news


Multiple terms or clauses can be grouped together with parentheses, to form sub-queries:

(quick OR brown) AND fox