2020-05-11 23:09:31 -04:00
---
stage: Configure
group: Configure
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---
2020-03-11 11:09:37 -04:00
# Kubernetes Logs
2019-05-05 08:29:36 -04:00
2020-03-23 23:09:28 -04:00
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4752) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.0.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25455) to [GitLab Core](https://about.gitlab.com/pricing/) 12.9.
2019-05-05 08:29:36 -04:00
GitLab makes it easy to view the logs of running pods in [connected Kubernetes clusters ](index.md ).
2020-05-07 20:09:56 -04:00
By displaying the logs directly in GitLab in the **Log Explorer** , developers can avoid
managing console tools or jumping to a different interface.
2019-07-29 00:55:01 -04:00
NOTE: **Kubernetes + GitLab**
2020-05-07 20:09:56 -04:00
Everything you need to build, test, deploy, and run your application at scale.
2019-07-29 00:55:01 -04:00
[Learn more ](https://about.gitlab.com/solutions/kubernetes/ ).
2019-05-05 08:29:36 -04:00
## Overview
2020-04-23 20:09:28 -04:00
[Kubernetes ](https://kubernetes.io ) logs can be viewed directly within GitLab with
the **Log Explorer** .
2019-11-18 07:06:03 -05:00
2020-04-13 11:09:20 -04:00
![Pod logs ](img/kubernetes_pod_logs_v12_10.png )
2019-11-18 07:06:03 -05:00
2020-04-23 20:09:28 -04:00
< i class = "fa fa-youtube-play youtube" aria-hidden = "true" > < / i >
To learn more, see [APM - Log Explorer ](https://www.youtube.com/watch?v=hWclZHA7Dgw ).
2019-11-18 07:06:03 -05:00
## Requirements
2020-05-07 20:09:56 -04:00
[Deploying to a Kubernetes environment ](../deploy_boards.md#enabling-deploy-boards )
is required to use Logs.
2019-11-18 07:06:03 -05:00
## Usage
2020-03-10 08:08:16 -04:00
To access logs, you must have the right [permissions ](../../permissions.md#project-members-permissions ).
2019-11-18 07:06:03 -05:00
You can access them in two ways.
### From the project sidebar
2020-02-06 10:09:11 -05:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 12.5.
2019-11-18 07:06:03 -05:00
2020-04-23 20:09:28 -04:00
Go to ** {cloud-gear}** **Operations > Pod logs** on the sidebar menu to display
the **Log Explorer** .
2019-11-18 07:06:03 -05:00
2020-04-13 11:09:20 -04:00
![Sidebar menu ](img/sidebar_menu_pod_logs_v12_10.png )
2019-11-18 07:06:03 -05:00
### From Deploy Boards
Logs can be displayed by clicking on a specific pod from [Deploy Boards ](../deploy_boards.md ):
2019-05-05 08:29:36 -04:00
2020-05-07 20:09:56 -04:00
1. Go to ** {cloud-gear}** **Operations > Environments** and find the environment
which contains the desired pod, like `production` .
1. On the **Environments** page, you should see the status of the environment's
pods with [Deploy Boards ](../deploy_boards.md ).
1. When mousing over the list of pods, a tooltip will appear with the exact pod name
and status.
2019-06-25 00:34:55 -04:00
![Deploy Boards pod list ](img/pod_logs_deploy_board.png )
2020-04-23 20:09:28 -04:00
1. Click on the desired pod to display the **Log Explorer** .
2019-10-18 14:06:21 -04:00
2020-01-13 19:08:14 -05:00
### Logs view
2020-04-23 20:09:28 -04:00
The **Log Explorer** lets you filter the logs by:
2020-01-13 19:08:14 -05:00
- Pods.
- [From GitLab 12.4 ](https://gitlab.com/gitlab-org/gitlab/issues/5769 ), environments.
2020-05-07 20:09:56 -04:00
- [From GitLab 12.7 ](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656 ),
[full text search ](#full-text-search ).
2020-02-13 13:09:00 -05:00
- [From GitLab 12.8 ](https://gitlab.com/gitlab-org/gitlab/issues/197879 ), dates.
2020-01-13 19:08:14 -05:00
2020-05-07 20:09:56 -04:00
Loading more than 500 log lines is possible from
[GitLab 12.9 ](https://gitlab.com/gitlab-org/gitlab/-/issues/198050 ) onward.
2020-03-13 08:09:22 -04:00
2020-05-07 20:09:56 -04:00
Support for pods with multiple containers is coming
[in a future release ](https://gitlab.com/gitlab-org/gitlab/issues/13404 ).
2020-01-13 19:08:14 -05:00
2020-05-07 20:09:56 -04:00
Support for historical data is coming
[in a future release ](https://gitlab.com/gitlab-org/gitlab/issues/196191 ).
2020-01-13 19:08:14 -05:00
2020-02-13 13:09:00 -05:00
### Filter by date
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/197879) in GitLab 12.8.
2020-05-07 20:09:56 -04:00
When you enable [Elastic Stack ](../../clusters/applications.md#elastic-stack )
on your cluster, you can filter logs displayed in the **Log Explorer** by date.
2020-02-13 13:09:00 -05:00
2020-04-23 20:09:28 -04:00
Click **Show last** in the **Log Explorer** to see the available options.
2020-02-13 13:09:00 -05:00
2020-01-13 19:08:14 -05:00
### Full text search
2020-02-13 13:09:00 -05:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656) in GitLab 12.7.
2020-01-13 19:08:14 -05:00
When you enable [Elastic Stack ](../../clusters/applications.md#elastic-stack ) on your cluster,
2020-02-20 13:08:51 -05:00
you can search the content of your logs through a search bar.
2020-01-13 19:08:14 -05:00
2020-05-07 20:09:56 -04:00
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 )
2020-01-13 19:08:14 -05:00
Elasticsearch function, which supports the following operators:
2020-02-12 13:09:21 -05:00
| Operator | Description |
|----------------------------|------------------------------------------------------------|
| `\|` | An OR operation. |
| `-` | Negates a single token. |
| `+` | An AND operation. |
| `"` | Wraps a number of tokens to signify a phrase for searching. |
| `*` (at the end of a term) | A prefix query. |
| `(` and `)` | Precedence. |
| `~N` (after a word) | Edit distance (fuzziness). |
| `~N` (after a phrase) | Slop amount. |