Add latest changes from gitlab-org/gitlab@master
This commit is contained in:
parent
2a87ae2e36
commit
bf3d94a733
|
@ -34,7 +34,7 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to
|
||||||
**3. Maintainer**
|
**3. Maintainer**
|
||||||
|
|
||||||
1. [ ] Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
|
1. [ ] Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
|
||||||
1. [ ] Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
|
1. [ ] Ensure a release milestone is set.
|
||||||
1. [ ] If there has not been a technical writer review, [create an issue for one using the Doc Review template](https://gitlab.com/gitlab-org/gitlab/issues/new?issuable_template=Doc%20Review).
|
1. [ ] If there has not been a technical writer review, [create an issue for one using the Doc Review template](https://gitlab.com/gitlab-org/gitlab/issues/new?issuable_template=Doc%20Review).
|
||||||
|
|
||||||
/label ~documentation
|
/label ~documentation
|
||||||
|
|
|
@ -13,7 +13,7 @@ export default {
|
||||||
Icon,
|
Icon,
|
||||||
},
|
},
|
||||||
data() {
|
data() {
|
||||||
return { placeholderUrl: 'https://my-url.grafana.net/my-dashboard' };
|
return { placeholderUrl: 'https://my-url.grafana.net/' };
|
||||||
},
|
},
|
||||||
computed: {
|
computed: {
|
||||||
...mapState(['operationsSettingsEndpoint', 'grafanaToken', 'grafanaUrl', 'grafanaEnabled']),
|
...mapState(['operationsSettingsEndpoint', 'grafanaToken', 'grafanaUrl', 'grafanaEnabled']),
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
- more_info_link = link_to _('More information'), help_page_path('user/project/clusters/add_remove_cluster.md',
|
- more_info_link = link_to _('More information'), help_page_path('user/project/clusters/add_remove_clusters.md',
|
||||||
anchor: 'add-existing-cluster'), target: '_blank'
|
anchor: 'add-existing-cluster'), target: '_blank'
|
||||||
- rbac_help_link = link_to _('More information'), help_page_path('user/project/clusters/add_remove_cluster.md',
|
- rbac_help_link = link_to _('More information'), help_page_path('user/project/clusters/add_remove_clusters.md',
|
||||||
anchor: 'access-controls'), target: '_blank'
|
anchor: 'access-controls'), target: '_blank'
|
||||||
|
|
||||||
- api_url_help_text = s_('ClusterIntegration|The URL used to access the Kubernetes API.')
|
- api_url_help_text = s_('ClusterIntegration|The URL used to access the Kubernetes API.')
|
||||||
|
|
|
@ -103,7 +103,7 @@ module Secpick
|
||||||
options[:branch] = branch
|
options[:branch] = branch
|
||||||
end
|
end
|
||||||
|
|
||||||
opts.on('-s', '--sha abcd', 'SHA to cherry pick') do |sha|
|
opts.on('-s', '--sha abcd', 'SHA or SHA range to cherry pick') do |sha|
|
||||||
options[:sha] = sha
|
options[:sha] = sha
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 40 KiB |
|
@ -211,11 +211,11 @@ The following tables outline the details of expected properties.
|
||||||
|
|
||||||
| Property | Type | Required | Description |
|
| Property | Type | Required | Description |
|
||||||
| ------ | ------ | ------ | ------- |
|
| ------ | ------ | ------ | ------- |
|
||||||
| `type` | enum | no, defaults to `area-chart` | Specifies the chart type to use, can be `area-chart` or `line-chart` |
|
| `type` | enum | no, defaults to `area-chart` | Specifies the chart type to use, can be: `area-chart`, `line-chart` or `anomaly-chart`. |
|
||||||
| `title` | string | yes | Heading for the panel. |
|
| `title` | string | yes | Heading for the panel. |
|
||||||
| `y_label` | string | no, but highly encouraged | Y-Axis label for the panel. |
|
| `y_label` | string | no, but highly encouraged | Y-Axis label for the panel. |
|
||||||
| `weight` | number | no, defaults to order in file | Order to appear within the grouping. Lower number means higher priority, which will be higher on the page. Numbers do not need to be consecutive. |
|
| `weight` | number | no, defaults to order in file | Order to appear within the grouping. Lower number means higher priority, which will be higher on the page. Numbers do not need to be consecutive. |
|
||||||
| `metrics` | array | yes | The metrics which should be displayed in the panel. |
|
| `metrics` | array | yes | The metrics which should be displayed in the panel. Any number of metrics can be displayed when `type` is `area-chart` or `line-chart`, whereas only 3 can be displayed when `type` is `anomaly-chart`. |
|
||||||
|
|
||||||
**Metrics (`metrics`) properties:**
|
**Metrics (`metrics`) properties:**
|
||||||
|
|
||||||
|
@ -231,20 +231,20 @@ The following tables outline the details of expected properties.
|
||||||
|
|
||||||
The below panel types are supported in monitoring dashboards.
|
The below panel types are supported in monitoring dashboards.
|
||||||
|
|
||||||
##### Area
|
##### Area or Line Chart
|
||||||
|
|
||||||
To add an area panel type to a dashboard, look at the following sample dashboard file:
|
To add an area chart panel type to a dashboard, look at the following sample dashboard file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
dashboard: 'Dashboard Title'
|
dashboard: 'Dashboard Title'
|
||||||
panel_groups:
|
panel_groups:
|
||||||
- group: 'Group Title'
|
- group: 'Group Title'
|
||||||
panels:
|
panels:
|
||||||
- type: area-chart
|
- type: area-chart # or line-chart
|
||||||
title: "Chart Title"
|
title: 'Area Chart Title'
|
||||||
y_label: "Y-Axis"
|
y_label: "Y-Axis"
|
||||||
metrics:
|
metrics:
|
||||||
- id: 10
|
- id: area_http_requests_total
|
||||||
query_range: 'http_requests_total'
|
query_range: 'http_requests_total'
|
||||||
label: "Metric of Ages"
|
label: "Metric of Ages"
|
||||||
unit: "count"
|
unit: "count"
|
||||||
|
@ -255,10 +255,52 @@ Note the following properties:
|
||||||
| Property | Type | Required | Description |
|
| Property | Type | Required | Description |
|
||||||
| ------ | ------ | ------ | ------ |
|
| ------ | ------ | ------ | ------ |
|
||||||
| type | string | no | Type of panel to be rendered. Optional for area panel types |
|
| type | string | no | Type of panel to be rendered. Optional for area panel types |
|
||||||
| query_range | yes | required | For area panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) |
|
| query_range | string | required | For area panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) |
|
||||||
|
|
||||||
![area panel type](img/prometheus_dashboard_area_panel_type.png)
|
![area panel type](img/prometheus_dashboard_area_panel_type.png)
|
||||||
|
|
||||||
|
##### Anomaly chart
|
||||||
|
|
||||||
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/16530) in GitLab 12.5.
|
||||||
|
|
||||||
|
To add an anomaly chart panel type to a dashboard, add add a panel with *exactly* 3 metrics.
|
||||||
|
|
||||||
|
The first metric represents the current state, and the second and third metrics represent the upper and lower limit respectively:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
dashboard: 'Dashboard Title'
|
||||||
|
panel_groups:
|
||||||
|
- group: 'Group Title'
|
||||||
|
panels:
|
||||||
|
- type: anomaly-chart
|
||||||
|
title: "Chart Title"
|
||||||
|
y_label: "Y-Axis"
|
||||||
|
metrics:
|
||||||
|
- id: anomaly_requests_normal
|
||||||
|
query_range: 'http_requests_total'
|
||||||
|
label: "# of Requests"
|
||||||
|
unit: "count"
|
||||||
|
metrics:
|
||||||
|
- id: anomaly_requests_upper_limit
|
||||||
|
query_range: 10000
|
||||||
|
label: "Max # of requests"
|
||||||
|
unit: "count"
|
||||||
|
metrics:
|
||||||
|
- id: anomaly_requests_lower_limit
|
||||||
|
query_range: 2000
|
||||||
|
label: "Min # of requests"
|
||||||
|
unit: "count"
|
||||||
|
```
|
||||||
|
|
||||||
|
Note the following properties:
|
||||||
|
|
||||||
|
| Property | Type | Required | Description |
|
||||||
|
| ------ | ------ | ------ | ------ |
|
||||||
|
| type | string | required | Must be `anomaly-chart` for anomaly panel types |
|
||||||
|
| query_range | yes | required | For anomaly panel types, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) in every metric. |
|
||||||
|
|
||||||
|
![anomaly panel type](img/prometheus_dashboard_anomaly_panel_type.png)
|
||||||
|
|
||||||
##### Single Stat
|
##### Single Stat
|
||||||
|
|
||||||
To add a single stat panel type to a dashboard, look at the following sample dashboard file:
|
To add a single stat panel type to a dashboard, look at the following sample dashboard file:
|
||||||
|
|
|
@ -51,7 +51,7 @@ exports[`grafana integration component default state to match the default snapsh
|
||||||
>
|
>
|
||||||
<glforminput-stub
|
<glforminput-stub
|
||||||
id="grafana-url"
|
id="grafana-url"
|
||||||
placeholder="https://my-url.grafana.net/my-dashboard"
|
placeholder="https://my-url.grafana.net/"
|
||||||
value="http://test.host"
|
value="http://test.host"
|
||||||
/>
|
/>
|
||||||
</glformgroup-stub>
|
</glformgroup-stub>
|
||||||
|
|
Loading…
Reference in New Issue