debian-mirror-gitlab/doc/user/project/clusters/kubernetes_pod_logs.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

122 lines
6.6 KiB
Markdown
Raw Normal View History

2020-05-24 23:13:21 +05:30
---
2020-10-24 23:57:45 +05:30
stage: Monitor
2022-04-04 11:22:00 +05:30
group: Respond
2021-02-22 17:27:13 +05:30
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/#assignments
2020-05-24 23:13:21 +05:30
---
2022-07-16 23:28:13 +05:30
# Kubernetes Logs (DEPRECATED) **(FREE SELF)**
2019-07-31 22:56:46 +05:30
2022-04-04 11:22:00 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4752) in GitLab 11.0.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26383) from GitLab Ultimate to GitLab Free 12.9.
2021-12-11 22:18:48 +05:30
> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
2022-07-16 23:28:13 +05:30
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/360182) behind a [feature flag](../../../administration/feature_flags.md) named `monitor_logging` in GitLab 15.0. Disabled by default.
> - [Disabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0.
2021-12-11 22:18:48 +05:30
WARNING:
2022-07-16 23:28:13 +05:30
This feature is in its end-of-life process.
2021-12-11 22:18:48 +05:30
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
2022-07-16 23:28:13 +05:30
It will be [removed completely](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) in GitLab 15.2.
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../../administration/feature_flags.md) named `monitor_logging` and the one named `certificate_based_clusters`.
On GitLab.com, this feature is not available.
This feature is not recommended for production use.
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
GitLab makes it easy to view the logs of running pods in
2020-10-24 23:57:45 +05:30
[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:
2019-12-26 22:10:19 +05:30
2020-04-22 19:07:51 +05:30
![Pod logs](img/kubernetes_pod_logs_v12_10.png)
2019-12-26 22:10:19 +05:30
2020-10-24 23:57:45 +05:30
- **Namespace** - Select the environment to display. Users with Maintainer or
2021-09-04 01:27:46 +05:30
greater [permissions](../../permissions.md) can also see pods in the
`gitlab-managed-apps` namespace.
- **Search** - Only available if the [Elastic Stack integration](../../clusters/integrations.md#elastic-stack-cluster-integration) is enabled.
- **Select time range** - Select the range of time to display.
Only available if the [Elastic Stack integration](../../clusters/integrations.md#elastic-stack-cluster-integration) is enabled.
2020-10-24 23:57:45 +05:30
- **Scroll to bottom** **{scroll_down}** - Scroll to the end of the displayed logs.
- **Refresh** **{retry}** - Reload the displayed logs.
2020-05-24 23:13:21 +05:30
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
2020-10-24 23:57:45 +05:30
To learn more about the Log Explorer, see [APM - Log Explorer](https://www.youtube.com/watch?v=hWclZHA7Dgw).
[Learn more about Kubernetes + GitLab](https://about.gitlab.com/solutions/kubernetes/).
Everything you need to build, test, deploy, and run your application at scale.
2020-05-24 23:13:21 +05:30
2019-12-26 22:10:19 +05:30
## Requirements
2020-05-24 23:13:21 +05:30
[Deploying to a Kubernetes environment](../deploy_boards.md#enabling-deploy-boards)
is required to use Logs.
2019-12-26 22:10:19 +05:30
2020-10-24 23:57:45 +05:30
## Accessing the log explorer
2019-12-26 22:10:19 +05:30
2022-07-23 23:45:48 +05:30
To access the **Log explorer**, select the **More actions** **{ellipsis_v}** menu on
2020-10-24 23:57:45 +05:30
a [metrics dashboard](../../../operations/metrics/index.md) and select **View logs**, or:
2019-12-26 22:10:19 +05:30
2020-10-24 23:57:45 +05:30
1. Sign in as a user with the _View pod logs_
[permissions](../../permissions.md#project-members-permissions) in the project.
2021-09-04 01:27:46 +05:30
1. To navigate to the **Log Explorer** from the sidebar menu, go to **Monitor > Logs**
([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 12.5.).
2021-11-11 11:23:49 +05:30
1. To navigate to the **Log Explorer** from a specific pod on a [deploy board](../deploy_boards.md):
2019-12-26 22:10:19 +05:30
2021-09-04 01:27:46 +05:30
1. Go to **Deployments > Environments** and find the environment
2020-10-24 23:57:45 +05:30
which contains the desired pod, like `production`.
1. On the **Environments** page, you should see the status of the environment's
2021-11-11 11:23:49 +05:30
pods with [deploy boards](../deploy_boards.md).
2020-10-24 23:57:45 +05:30
1. When mousing over the list of pods, GitLab displays a tooltip with the exact pod name
and status.
2021-11-11 11:23:49 +05:30
![deploy boards pod list](img/pod_logs_deploy_board.png)
2022-07-23 23:45:48 +05:30
1. Select the desired pod to display the **Log Explorer**.
2019-12-21 20:55:43 +05:30
2020-03-13 15:44:24 +05:30
### Logs view
2020-05-24 23:13:21 +05:30
The **Log Explorer** lets you filter the logs by:
2020-03-13 15:44:24 +05:30
- Pods.
2020-06-23 00:09:42 +05:30
- [From GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/5769), environments.
2020-05-24 23:13:21 +05:30
- [From GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656),
[full text search](#full-text-search).
2020-06-23 00:09:42 +05:30
- [From GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/197879), dates.
2020-10-24 23:57:45 +05:30
- [From GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/208790), managed apps.
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
Loading more than 500 log lines is possible from
[GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/198050) onward.
2020-04-08 14:13:33 +05:30
2020-05-24 23:13:21 +05:30
Support for pods with multiple containers is coming
2020-06-23 00:09:42 +05:30
[in a future release](https://gitlab.com/gitlab-org/gitlab/-/issues/13404).
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
Support for historical data is coming
2020-06-23 00:09:42 +05:30
[in a future release](https://gitlab.com/gitlab-org/gitlab/-/issues/196191).
2020-03-13 15:44:24 +05:30
### Filter by date
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/197879) in GitLab 12.8.
2020-03-13 15:44:24 +05:30
2021-09-04 01:27:46 +05:30
When you enable [Elastic Stack](../../clusters/integrations.md#elastic-stack-cluster-integration)
2020-05-24 23:13:21 +05:30
on your cluster, you can filter logs displayed in the **Log Explorer** by date.
2020-03-13 15:44:24 +05:30
2022-07-23 23:45:48 +05:30
Select **Show last** in the **Log Explorer** to see the available options.
2020-03-13 15:44:24 +05:30
### Full text search
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656) in GitLab 12.7.
2021-09-04 01:27:46 +05:30
When you enable [Elastic Stack](../../clusters/integrations.md#elastic-stack-cluster-integration) on your cluster,
2020-10-24 23:57:45 +05:30
you can search the content of your logs through a search bar. The search is passed
to Elasticsearch using the
2020-05-24 23:13:21 +05:30
[simple_query_string](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)
2020-03-13 15:44:24 +05:30
Elasticsearch function, which supports the following operators:
2020-10-24 23:57:45 +05:30
| Operator | Description |
|----------------------------|-------------------------------------------------------------|
| `\|` | An `OR` operation. |
2020-03-13 15:44:24 +05:30
| `-` | Negates a single token. |
2020-10-24 23:57:45 +05:30
| `+` | An `AND` operation. |
2020-03-13 15:44:24 +05:30
| `"` | 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. |