Commit 64e2ee03 authored by Amy Qualls's avatar Amy Qualls

Reshape and revise the pod logs page

The pod logs page needed revision and cleanup after one of the
form fields changed.
parent 287d98ab
--- ---
stage: Configure stage: Monitor
group: Configure group: APM
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 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
--- ---
...@@ -9,56 +9,54 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,56 +9,54 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4752) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.0. > - [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/26383) to [GitLab Core](https://about.gitlab.com/pricing/) 12.9. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26383) to [GitLab Core](https://about.gitlab.com/pricing/) 12.9.
GitLab makes it easy to view the logs of running pods in [connected Kubernetes clusters](index.md). GitLab makes it easy to view the logs of running pods or managed applications in
By displaying the logs directly in GitLab in the **Log Explorer**, developers can avoid [connected Kubernetes clusters](index.md). By displaying the logs directly in GitLab
managing console tools or jumping to a different interface. in the **Log Explorer**, developers can avoid managing console tools or jumping
to a different interface. The **Log Explorer** interface provides a set of filters
NOTE: **Note:** above the log file data, depending on your configuration:
[Learn more about Kubernetes + GitLab](https://about.gitlab.com/solutions/kubernetes/).
Everything you need to build, test, deploy, and run your application at scale.
## Overview
[Kubernetes](https://kubernetes.io) logs can be viewed directly within GitLab with
the **Log Explorer**.
![Pod logs](img/kubernetes_pod_logs_v12_10.png) ![Pod logs](img/kubernetes_pod_logs_v12_10.png)
- **Namespace** - Select the environment to display. Users with Maintainer or
greater [permissions](../../permissions.md) can also select Managed Apps.
- **Search** - Only available if the Elastic Stack managed application is installed.
- **Time picker** - Select the range of time to display. Only available if the
Elastic Stack managed application is installed.
- **Scroll to bottom** **{scroll_down}** - Scroll to the end of the displayed logs.
- **Refresh** **{retry}** - Reload the displayed logs.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> <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). To learn more about the Log Explorer, see [APM - Log Explorer](https://www.youtube.com/watch?v=hWclZHA7Dgw).
NOTE: **Note:**
[Learn more about Kubernetes + GitLab](https://about.gitlab.com/solutions/kubernetes/).
Everything you need to build, test, deploy, and run your application at scale.
## Requirements ## Requirements
[Deploying to a Kubernetes environment](../deploy_boards.md#enabling-deploy-boards) [Deploying to a Kubernetes environment](../deploy_boards.md#enabling-deploy-boards)
is required to use Logs. is required to use Logs.
## Usage ## Accessing the log explorer
To access logs, you must have the right [permissions](../../permissions.md#project-members-permissions).
You can access them in two ways.
### From the project sidebar
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 12.5. To access the **Log explorer**, click the **More actions** **{ellipsis_v}** menu on
a [metrics dashboard](../../../operations/metrics/index.md) and select **View logs**, or:
Go to **{cloud-gear}** **Operations > Pod logs** on the sidebar menu to display 1. Sign in as a user with the _View pod logs_
the **Log Explorer**. [permissions](../../permissions.md#project-members-permissions) in the project.
1. *To navigate to the **Log Explorer** from the sidebar menu,* go to
**{cloud-gear}** **Operations > Pod logs**.
([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 12.5.)
1. *To navigate to the **Log Explorer** from a specific pod on a [Deploy Board](../deploy_boards.md):*
![Sidebar menu](img/sidebar_menu_pod_logs_v12_10.png) 1. Go to **{cloud-gear}** **Operations > Environments** and find the environment
which contains the desired pod, like `production`.
### From Deploy Boards 1. On the **Environments** page, you should see the status of the environment's
pods with [Deploy Boards](../deploy_boards.md).
Logs can be displayed by clicking on a specific pod from [Deploy Boards](../deploy_boards.md): 1. When mousing over the list of pods, GitLab displays a tooltip with the exact pod name
and status.
1. Go to **{cloud-gear}** **Operations > Environments** and find the environment ![Deploy Boards pod list](img/pod_logs_deploy_board.png)
which contains the desired pod, like `production`. 1. Click on the desired pod to display the **Log Explorer**.
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.
![Deploy Boards pod list](img/pod_logs_deploy_board.png)
1. Click on the desired pod to display the **Log Explorer**.
### Logs view ### Logs view
...@@ -69,6 +67,7 @@ The **Log Explorer** lets you filter the logs by: ...@@ -69,6 +67,7 @@ The **Log Explorer** lets you filter the logs by:
- [From GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656), - [From GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656),
[full text search](#full-text-search). [full text search](#full-text-search).
- [From GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/197879), dates. - [From GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/197879), dates.
- [From GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/208790), managed apps.
Loading more than 500 log lines is possible from Loading more than 500 log lines is possible from
[GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/198050) onward. [GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/198050) onward.
...@@ -93,17 +92,16 @@ Click **Show last** in the **Log Explorer** to see the available options. ...@@ -93,17 +92,16 @@ Click **Show last** in the **Log Explorer** to see the available options.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656) in GitLab 12.7. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656) in GitLab 12.7.
When you enable [Elastic Stack](../../clusters/applications.md#elastic-stack) on your cluster, When you enable [Elastic Stack](../../clusters/applications.md#elastic-stack) on your cluster,
you can search the content of your logs through a search bar. you can search the content of your logs through a search bar. The search is passed
to Elasticsearch using the
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) [simple_query_string](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)
Elasticsearch function, which supports the following operators: Elasticsearch function, which supports the following operators:
| Operator | Description | | Operator | Description |
|----------------------------|------------------------------------------------------------| |----------------------------|-------------------------------------------------------------|
| `\|` | An OR operation. | | `\|` | An `OR` operation. |
| `-` | Negates a single token. | | `-` | Negates a single token. |
| `+` | An AND operation. | | `+` | An `AND` operation. |
| `"` | Wraps a number of tokens to signify a phrase for searching. | | `"` | Wraps a number of tokens to signify a phrase for searching. |
| `*` (at the end of a term) | A prefix query. | | `*` (at the end of a term) | A prefix query. |
| `(` and `)` | Precedence. | | `(` and `)` | Precedence. |
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment