Merge branch 'docs-aqualls-logs-linking' into 'master'

Reshape and revise the pod logs page See merge request gitlab-org/gitlab!37376

Merge branch 'docs-aqualls-logs-linking' into 'master'
Reshape and revise the pod logs page See merge request gitlab-org/gitlab!37376
a64f6362 · Amy Qualls · 1042adb2 · 64e2ee03 · 1042adb2 · a64f6362
Commit a64f6362 authored Jul 24, 2020 by Amy Qualls
2 changed files
--- a/doc/user/project/clusters/img/sidebar_menu_pod_logs_v12_10.png
+++ b/doc/user/project/clusters/img/sidebar_menu_pod_logs_v12_10.png
--- a/doc/user/project/clusters/kubernetes_pod_logs.md
+++ b/doc/user/project/clusters/kubernetes_pod_logs.md
 ---
-stage: Configure
-group: Configure
+stage: Monitor
+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
 ---

@@ -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.
 > - [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).
-By displaying the logs directly in GitLab in the **Log Explorer**, developers can avoid
-managing console tools or jumping to a different interface.
-
-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.
-
-## Overview
-
-[Kubernetes](https://kubernetes.io) logs can be viewed directly within GitLab with
-the **Log Explorer**.
+GitLab makes it easy to view the logs of running pods or managed applications in
+[connected Kubernetes clusters](index.md). By displaying the logs directly in GitLab
+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
+above the log file data, depending on your configuration:

 ![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>
-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

 [Deploying to a Kubernetes environment](../deploy_boards.md#enabling-deploy-boards)
 is required to use Logs.

-## Usage
-
-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
+## Accessing the log explorer

-> [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
-the **Log Explorer**.
+1. Sign in as a user with the _View pod logs_
+   [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)
-
-### From Deploy Boards
-
-Logs can be displayed by clicking on a specific pod from [Deploy Boards](../deploy_boards.md):
-
-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.
-   ![Deploy Boards pod list](img/pod_logs_deploy_board.png)
-1. Click on the desired pod to display the **Log Explorer**.
+   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, GitLab displays a tooltip 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

@@ -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),
  [full text search](#full-text-search).
 - [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
 [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.
 > [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,
-you can search the content of your logs through a search bar.
-
-The search is passed on to Elasticsearch using the
+you can search the content of your logs through a search bar. The search is passed
+to Elasticsearch using the
 [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:

-| Operator                   | Description                                                |
-|----------------------------|------------------------------------------------------------|
-|  `\|`                      | An OR operation.                                            |
+| Operator                   | Description                                                 |
+|----------------------------|-------------------------------------------------------------|
+|  `\|`                      | An `OR` operation.                                          |
 | `-`                        | Negates a single token.                                     |
-| `+`                        | An AND operation.                                           |
+| `+`                        | 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.                                                 |