Add full text search to pod logs (!21656) · Merge Requests · GitLab.org / GitLab

Add full text search to pod logs

What does this MR do?

As per #39166 (closed) and #36342 (closed), adds a search bar to the logs UI.

You need Feature.enable(:enable_cluster_application_elastic_stack)

The search is passed on to ElasticSearch using the simple_query_string function:

The simple_query_string query supports the following operators:

+ signifies AND operation
| signifies OR operation
- negates a single token
" wraps a number of tokens to signify a phrase for searching
* at the end of a term signifies a prefix query
( and ) signify precedence
~N after a word signifies edit distance (fuzziness)
~N after a phrase signifies slop amount

Screenshots

Example of searching for GET in logs, showing disabled behavior when test-instance is selected (doesn't have Elasticsearch)

Screen_Recording_2019-12-12_at_15.33.42

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process.
Tested in all supported browsers

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

Label as security and @ mention @gitlab-com/gl-security/appsec
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
Security reports checked/validated by a reviewer from the AppSec team

## What does this MR do?

As per https://gitlab.com/gitlab-org/gitlab/issues/39166 and https://gitlab.com/gitlab-org/gitlab/issues/36342, adds a search bar to the logs UI.

You need `Feature.enable(:enable_cluster_application_elastic_stack)`

The search is passed on to ElasticSearch using the [simple_query_string](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) function:

> ```
> The simple_query_string query supports the following operators:
> 
> + signifies AND operation
> | signifies OR operation
> - negates a single token
> " wraps a number of tokens to signify a phrase for searching
> * at the end of a term signifies a prefix query
> ( and ) signify precedence
> ~N after a word signifies edit distance (fuzziness)
> ~N after a phrase signifies slop amount
> ```

## Screenshots

Example of searching for `GET` in logs, showing disabled behavior when `test-instance` is selected (doesn't have Elasticsearch)

![Screen_Recording_2019-12-12_at_15.33.42](/uploads/5c8e5e922e6069725b9b478f79db9a01/Screen_Recording_2019-12-12_at_15.33.42.mov)

## Does this MR meet the acceptance criteria?

### Conformity

- [x] [Changelog entry](https://docs.gitlab.com/ee/development/changelog.html) 
- [ ] [Documentation](https://docs.gitlab.com/ee/development/documentation/workflow.html) ([if required](https://docs.gitlab.com/ee/development/documentation/workflow.html#when-documentation-is-required))
- [x] [Code review guidelines](https://docs.gitlab.com/ee/development/code_review.html)
- [x] [Merge request performance guidelines](https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html)
- [x] [Style guides](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/doc/development/contributing/style_guides.md)
- [x] [Database guides](https://docs.gitlab.com/ee/development/README.html#database-guides)
- [x] [Separation of EE specific content](https://docs.gitlab.com/ee/development/ee_features.html#separation-of-ee-code)

### Availability and Testing

- [x] [Review and add/update tests for this feature/bug](https://docs.gitlab.com/ee/development/testing_guide/index.html). Consider [all test levels](https://docs.gitlab.com/ee/development/testing_guide/testing_levels.html). See the [Test Planning Process](https://about.gitlab.com/handbook/engineering/quality/test-engineering).
- [ ] [Tested in all supported browsers](https://docs.gitlab.com/ee/install/requirements.html#supported-web-browsers)

### Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in [the security review guidelines](https://about.gitlab.com/handbook/engineering/security/#when-to-request-a-security-review):

- [ ] Label as ~security and @ mention `@gitlab-com/gl-security/appsec`
- [ ] The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
- [ ] Security reports checked/validated by a reviewer from the AppSec team

Edited Dec 18, 2019 by Adrien Kohlbecker