diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-31 18:09:11 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-31 18:09:11 +0000 |
commit | 0434f38ef1dce4fe640fe1e4542235746ceb943c (patch) | |
tree | 3affe5902c9da74441dfbf5069f76c023b5cd03a /doc | |
parent | c27acb1d376f7127cd33eadcc8f5683ed55262bc (diff) | |
download | gitlab-ce-0434f38ef1dce4fe640fe1e4542235746ceb943c.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/code_review.md | 6 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 5 | ||||
-rw-r--r-- | doc/user/incident_management/index.md | 24 | ||||
-rw-r--r-- | doc/user/project/img/labels_delete_v12_1.png | bin | 9531 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_list_v12_1.png | bin | 104907 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/img/labels_new_label_from_sidebar.gif | bin | 759243 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png | bin | 0 -> 13219 bytes | |||
-rw-r--r-- | doc/user/project/integrations/img/prometheus_service_configuration.png | bin | 18100 -> 5022 bytes | |||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 32 |
9 files changed, 34 insertions, 33 deletions
diff --git a/doc/development/code_review.md b/doc/development/code_review.md index 4bc963222f2..9b82cf5ff99 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -59,12 +59,12 @@ are recommended to get your merge request approved and merged by maintainer(s) from teams other than your own. 1. If your merge request includes backend changes [^1], it must be - **approved by a [backend maintainer](https://about.gitlab.com/handbook/engineering/projects/#gitlab-ce_maintainers_backend)**. + **approved by a [backend maintainer](https://about.gitlab.com/handbook/engineering/projects/#gitlab_maintainers_backend)**. 1. If your merge request includes database migrations or changes to expensive queries [^2], it must be - **approved by a [database maintainer](https://about.gitlab.com/handbook/engineering/projects/#gitlab-ce_maintainers_database)**. + **approved by a [database maintainer](https://about.gitlab.com/handbook/engineering/projects/#gitlab_maintainers_database)**. Read the [database review guidelines](database_review.md) for more details. 1. If your merge request includes frontend changes [^1], it must be - **approved by a [frontend maintainer](https://about.gitlab.com/handbook/engineering/projects/#gitlab-ce_maintainers_frontend)**. + **approved by a [frontend maintainer](https://about.gitlab.com/handbook/engineering/projects/#gitlab_maintainers_frontend)**. 1. If your merge request includes UX changes [^1], it must be **approved by a [UX team member](https://about.gitlab.com/company/team/)**. 1. If your merge request includes adding a new JavaScript library [^1], it must be diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 9c4b97c4adf..f979f882948 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -645,9 +645,8 @@ To indicate the steps of navigation through the UI: - Images should have a specific, non-generic name that will differentiate and describe them properly. - Always add to the end of the file name the GitLab release version - number corresponding to the release milestone the image was added to, - or corresponding to the release the screenshot was taken from, using the - format `image_name_vX_Y.png`. + corresponding to the version the screenshot was taken from, using the format + `image_name_vX_Y.png`. ([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/61027) in GitLab 12.1.) - For example, for a screenshot taken from the pipelines page of GitLab 11.1, a valid name is `pipelines_v11_1.png`. If you're diff --git a/doc/user/incident_management/index.md b/doc/user/incident_management/index.md index febe1a2423a..c644c5801df 100644 --- a/doc/user/incident_management/index.md +++ b/doc/user/incident_management/index.md @@ -98,30 +98,6 @@ members can join swiftly without requesting a link. Read more how to [add or remove a zoom meeting](../project/issues/associate_zoom_meeting.md). -### Alerting - -You can let GitLab know of alerts that may be triggering in your applications and services. GitLab can react to these by automatically creating Issues, and alerting developers via Email. - -#### Prometheus Alerts - -Prometheus alerts can be setup in both GitLab-managed Prometheus installs and self-managed Prometheus installs. - -Documentation for each method can be found here: - -- [GitLab-managed Prometheus](../project/integrations/prometheus.md#setting-up-alerts-for-prometheus-metrics-ultimate) -- [Self-managed Prometheus](../project/integrations/prometheus.md#external-prometheus-instances) - -#### Alert Endpoint - -GitLab can accept alerts from any source via a generic webhook receiver. When you set up the generic alerts integration, a unique endpoint will -be created which can receive a payload in JSON format. - -More information on setting this up, including how to customize the payload [can be found here](../project/integrations/generic_alerts.md). - -#### Recovery Alerts - -Coming soon: GitLab can automatically close Issues that have been automatically created when we receive notification that the alert is resolved. - ### Configuring Incidents Incident Management features can be easily enabled & disabled via the Project settings page. Head to Project -> Settings -> Operations -> Incidents. diff --git a/doc/user/project/img/labels_delete_v12_1.png b/doc/user/project/img/labels_delete_v12_1.png Binary files differdeleted file mode 100644 index 566e0519fbe..00000000000 --- a/doc/user/project/img/labels_delete_v12_1.png +++ /dev/null diff --git a/doc/user/project/img/labels_list_v12_1.png b/doc/user/project/img/labels_list_v12_1.png Binary files differdeleted file mode 100644 index 47359d05f7f..00000000000 --- a/doc/user/project/img/labels_list_v12_1.png +++ /dev/null diff --git a/doc/user/project/img/labels_new_label_from_sidebar.gif b/doc/user/project/img/labels_new_label_from_sidebar.gif Binary files differdeleted file mode 100644 index 572b29a86e1..00000000000 --- a/doc/user/project/img/labels_new_label_from_sidebar.gif +++ /dev/null diff --git a/doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png b/doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png Binary files differnew file mode 100644 index 00000000000..985f2b04ef3 --- /dev/null +++ b/doc/user/project/integrations/img/prometheus_dashboard_column_panel_type.png diff --git a/doc/user/project/integrations/img/prometheus_service_configuration.png b/doc/user/project/integrations/img/prometheus_service_configuration.png Binary files differindex c7dfe874817..a38d1bce197 100644 --- a/doc/user/project/integrations/img/prometheus_service_configuration.png +++ b/doc/user/project/integrations/img/prometheus_service_configuration.png diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index d8938d81637..90026833ec6 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -96,9 +96,8 @@ to integrate with. 1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) 1. Click the **Prometheus** service -1. Provide the base URL of the your server, for example `http://prometheus.example.com/`. - The **Test Settings** button can be used to confirm connectivity from GitLab - to the Prometheus server. +1. Provide the base URL of your server, for example `http://prometheus.example.com/` +1. Click **Save changes** ![Configure Prometheus Service](img/prometheus_service_configuration.png) @@ -330,6 +329,33 @@ Note the following properties: ![anomaly panel type](img/prometheus_dashboard_anomaly_panel_type.png) +#### Column + +To add a column panel type to a dashboard, look at the following sample dashboard file: + +```yaml +dashboard: 'Dashboard Title' +panel_groups: + - group: 'Group title' + panels: + - title: "Column" + type: "column" + metrics: + - id: 1024_memory + query: 'avg(sum(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}) by (job)) without (job) / count(avg(container_memory_usage_bytes{container_name!="POD",pod_name=~"^%{ci_environment_slug}-([^c].*|c([^a]|a([^n]|n([^a]|a([^r]|r[^y])))).*|)-(.*)",namespace="%{kube_namespace}"}) without (job)) /1024/1024' + unit: MB + label: "Memory Usage" +``` + +Note the following properties: + +| Property | Type | Required | Description | +| ------ | ------ | ------ | ------ | +| type | string | yes | Type of panel to be rendered. For column panel types, set to `column` | +| query_range | yes | yes | For column panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) | + +![anomaly panel type](img/prometheus_dashboard_column_panel_type.png) + ##### Single Stat To add a single stat panel type to a dashboard, look at the following sample dashboard file: |