WARNING: Version 4.1 of Kibana has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Accessing Kibana Visualize »
Elastic Docs ›Kibana User Guide [4.1]

Discover

edit

Discover

edit

You can interactively explore your data from the Discover page. You have access to every document in every index that matches the selected index pattern. You can submit search queries, filter the search results, and view document data. You can also see the number of documents that match the search query and get field value statistics. If a time field is configured for the selected index pattern, the distribution of documents over time is displayed in a histogram at the top of the page.

Discover Page

Setting the Time Filter

edit

The Time Filter restricts the search results to a specific time period. You can set a time filter if your index contains time-based events and a time-field is configured for the selected index pattern.

By default the time filter is set to the last 15 minutes. You can use the Time Picker to change the time filter or select a specific time interval or time range in the histogram at the top of the page.

To set a time filter with the Time Picker:

  1. Click the Time Filter displayed in the upper right corner of the menu bar to open the Time Picker.
  2. To set a quick filter, simply click one of the shortcut links.
  3. To specify a relative Time Filter, click Relative and enter the relative start time. You can specify the relative start time as any number of seconds, minutes, hours, days, months, or years ago.
  4. To specify an absolute Time Filter, click Absolute and enter the start date in the From field and the end date in the To field.
  5. Click the caret at the bottom of the Time Picker to hide it.

To set a Time Filter from the histogram, do one of the following:

  • Click the bar that represents the time interval you want to zoom in on.
  • Click and drag to view a specific timespan. You must start the selection with the cursor over the background of the chart—​the cursor changes to a plus sign when you hover over a valid start point.

You can use the browser Back button to undo your changes.

The histogram lists the time range you’re currently exploring, as well as the intervals that range is currently using. To change the intervals, click the link and select an interval from the drop-down. The default behavior automatically sets an interval based on the time range.

Searching Your Data

edit

You can search the indices that match the current index pattern by submitting a search from the Discover page. You can enter simple query strings, use the Lucene query syntax, or use the full JSON-based Elasticsearch Query DSL.

When you submit a search, the histogram, Documents table, and Fields list are updated to reflect the search results. The total number of hits (matching documents) is shown in the upper right corner of the histogram. The Documents table shows the first five hundred hits. By default, the hits are listed in reverse chronological order, with the newest documents shown first. You can reverse the sort order by by clicking on the Time column header. You can also sort the table using the values in any indexed field. For more information, see Sorting the Documents Table.

To search your data:

  1. Enter a query string in the Search field:

    • To perform a free text search, simply enter a text string. For example, if you’re searching web server logs, you could enter safari to search all fields for the term safari.
    • To search for a value in a specific field, you prefix the value with the name of the field. For example, you could enter status:200 to limit the results to entries that contain the value 200 in the status field.
    • To search for a range of values, you can use the bracketed range syntax, [START_VALUE TO END_VALUE]. For example, to find entries that have 4xx status codes, you could enter status:[400 TO 499].

    • To specify more complex search criteria, you can use the Boolean operators AND, OR, and NOT. For example, to find entries that have 4xx status codes and have an extension of php or html, you could enter status:[400 TO 499] AND (extension:php OR extension:html).

      These examples use the Lucene query syntax. You can also submit queries using the Elasticsearch Query DSL. For examples, see query string syntax in the Elasticsearch Reference.

  2. Press Enter or click the Search button to submit your search query.

Starting a New Search

edit

To clear the current search and start a new search, click the New Search button in the Discover toolbar.

New Search

Saving a Search

edit

You can reload saved searches on the Discover page and use them as the basis of visualizations. Saving a search saves both the search query string and the currently selected index pattern.

To save the current search:

  1. Click the Save Search button Save Search button in the Discover toolbar.
  2. Enter a name for the search and click Save.

Loading a Saved Search

edit

To load a saved search:

  1. Click the Load Search button Load Search button in the Discover toolbar.
  2. Select the search you want to load.

If the saved search is associated with a different index pattern than is currently selected, loading the saved search also changes the selected index pattern.

Changing Which Indices You’re Searching

edit

When you submit a search request, the indices that match the currently-selected index pattern are searched. The current index pattern is shown below the search field. To change which indices you are searching, click the name of the current index pattern to display a list of the configured index patterns and select a different index pattern.

For more information about index patterns, see Creating an Index Pattern.

Automatically Refreshing the Page

edit

You can configure a refresh interval to automatically refresh the page with the latest index data. This periodically resubmits the search query.

When a refresh interval is set, it is displayed to the left of the Time Filter in the menu bar.

To set the refresh interval:

  1. Click the Time Filter Time Filter in the upper right corner of the menu bar.
  2. Click the Refresh Interval tab.
  3. Choose a refresh interval from the list.

To automatically refresh the data, click the autorefresh Auto-refresh button and select an autorefresh interval:

image::images/autorefresh-intervals.png

When auto-refresh is enabled, Kibana’s top bar displays a pause button and the auto-refresh interval: autorefresh pause. Click the Pause button to pause auto-refresh.

Filtering by Field

edit

You can filter the search results to display only those documents that contain a particular value in a field. You can also create negative filters that exclude documents that contain the specified field value.

You can add filters from the Fields list or from the Documents table. When you add a filter, it is displayed in the filter bar below the search query. From the filter bar, you can enable or disable a filter, invert the filter (change it from a positive filter to a negative filter and vice-versa), toggle the filter on or off, or remove it entirely. Click the small left-facing arrow to the right of the index pattern selection drop-down to collapse the Fields list.

To add a filter from the Fields list:

  1. Click the name of the field you want to filter on. This displays the top five values for that field. To the right of each value, there are two magnifying glass buttons—​one for adding a regular (positive) filter, and one for adding a negative filter.
  2. To add a positive filter, click the Positive Filter button Positive Filter Button. This filters out documents that don’t contain that value in the field.
  3. To add a negative filter, click the Negative Filter button Negative Filter Button. This excludes documents that contain that value in the field.

To add a filter from the Documents table:

  1. Expand a document in the Documents table by clicking the Expand button Expand Button to the left of the document’s entry in the first column (the first column is usually Time). To the right of each field name, there are two magnifying glass buttons—​one for adding a regular (positive) filter, and one for adding a negative filter.
  2. To add a positive filter based on the document’s value in a field, click the Positive Filter button Positive Filter Button. This filters out documents that don’t contain the specified value in that field.
  3. To add a negative filter based on the document’s value in a field, click the Negative Filter button Negative Filter Button. This excludes documents that contain the specified value in that field.

Working with Filters

edit

When you create a filter anywhere in Kibana, the filter conditions display in a green oval under the search text entry box:

filter sample

Hovering on the filter oval displays the following icons:

filter allbuttons
Enable Filter filter enable
Click this icon to disable the filter without removing it. You can enable the filter again later by clicking the icon again. Disabled filters display a striped shaded color, green for inclusion filters and red for exclusion filters.
Pin Filter filter pin
Click this icon to pin a filter. Pinned filters persist across Kibana tabs. You can pin filters from the Visualize tab, click on the Discover or Dashboard tabs, and those filters remain in place. NOTE: If you have a pinned filter and you’re not seeing any query results, check that your current tab’s index pattern is one that the filter applies to.
Toggle Filter filter toggle
Click this icon to toggle a filter. By default, filters are inclusion filters, and display in green. Only elements that match the filter are displayed. To change this to an exclusion filters, displaying only elements that don’t match, toggle the filter. Exclusion filters display in red.
Remove Filter filter delete
Click this icon to remove a filter entirely.

To apply any of the filter actions to all the filters currently in place, click the filter actions Global Filter Actions button and select an action.

Viewing Document Data

edit

When you submit a search query, the 500 most recent documents that match the query are listed in the Documents table. You can configure the number of documents shown in the table by setting the discover:sampleSize property in Advanced Settings. By default, the table shows the localized version of the time field specified in the selected index pattern and the document _source. You can add fields to the Documents table from the Fields list. You can sort the listed documents by any indexed field that’s included in the table.

To view a document’s field data, click the Expand button Expand Button to the left of the document’s entry in the first column (the first column is usually Time). Kibana reads the document data from Elasticsearch and displays the document fields in a table. The table contains a row for each field that contains the name of the field, add filter buttons, and the field value.

Expanded Document
  1. To view the original JSON document (pretty-printed), click the JSON tab.
  2. To view the document data as a separate page, click the link. You can bookmark and share this link to provide direct access to a particular document.
  3. To collapse the document details, click the Collapse button Collapse Button.
  4. To toggle a particular field’s column in the Documents table, click the Add Column Toggle column in table button.

Sorting the Document List

edit

You can sort the documents in the Documents table by the values in any indexed field. If a time field is configured for the selected index pattern, by default the documents are sorted in reverse chronological order.

To change the sort order:

  • Click the name of the field you want to sort by. The fields you can use for sorting have a sort button to the right of the field name. Clicking the field name a second time reverses the sort order.

Adding Field Columns to the Documents Table

edit

By default, the Documents table shows the localized version of the time field specified in the selected index pattern and the document _source. You can add fields to the table from the Fields list or from a document’s expanded view.

To add field columns to the Documents table:

  1. Mouse over a field in the Fields list and click its add button Add Field Button.
  2. Repeat until you’ve added all the fields you want to display in the Documents table.
  3. Alternately, add a field column directly from a document’s expanded view by clicking the Add Column Toggle column in table button.

The added field columns replace the _source column in the Documents table. The added fields are also listed in the Selected Fields section at the top of the field list.

To rearrange the field columns in the table, mouse over the header of the column you want to move and click the Move button.

Move Column

Removing Field Columns from the Documents Table

edit

To remove field columns from the Documents table:

  1. Mouse over the field you want to remove in the Selected Fields section of the Fields list and click its remove button Remove Field Button.
  2. Repeat until you’ve removed all the fields you want to drop from the Documents table.

Viewing Field Data Statistics

edit

From the field list, you can see how many documents in the Documents table contain a particular field, what the top 5 values are, and what percentage of documents contain each value.

To view field data statistics:

  • Click the name of a field in the Fields list. The field can be anywhere in the Fields list—​Selected Fields, Popular Fields, or the list of other fields.

Field Statistics

To create a visualization based on the field, click the Visualize button below the field statistics.

« Accessing Kibana Visualize »