diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-10 21:09:32 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-10 21:09:32 +0300 |
commit | ed5add1c2f001c9bd54e664b32f212de172eca6a (patch) | |
tree | f9449cbecde36706f25a62f426b5398566ae5cca /doc | |
parent | de2fb5b82c92c90f90ed67ced45143c04e934fb8 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/instance_limits.md | 12 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 17 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 54 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 7 | ||||
-rw-r--r-- | doc/development/understanding_explain_plans.md | 4 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 1 |
6 files changed, 93 insertions, 2 deletions
diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index cf4cd9f4345..57acdec4ea2 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -178,6 +178,18 @@ Plan.default.limits.update!(ci_pipeline_schedules: 100) ## Instance monitoring and metrics +### Incident Management inbound alert limits + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14932) in GitLab 12.5. + +Limiting inbound alerts for an incident reduces the number of alerts (issues) +that can be created within a period of time, which can help prevent overloading +your incident responders with duplicate issues. You can reduce the volume of +alerts in the following ways: + +- Max requests per period per project, 3600 seconds by default. +- Rate limit period in seconds, 3600 seconds by default. + ### Prometheus Alert JSON payloads > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14929) in GitLab 12.6. diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index e79d52d4d10..22ca25e45d3 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1883,6 +1883,16 @@ type Environment { id: ID! """ + Metrics dashboard schema for the environment + """ + metricsDashboard( + """ + Path to a file which defines metrics dashboard eg: 'config/prometheus/common_metrics.yml' + """ + path: String! + ): MetricsDashboard + + """ Human-readable name of the environment """ name: String! @@ -5278,6 +5288,13 @@ type Metadata { version: String! } +type MetricsDashboard { + """ + Path to a file with the dashboard definition + """ + path: String +} + """ Represents a milestone. """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 820f41755d0..40bd27062b3 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -5581,6 +5581,33 @@ "deprecationReason": null }, { + "name": "metricsDashboard", + "description": "Metrics dashboard schema for the environment", + "args": [ + { + "name": "path", + "description": "Path to a file which defines metrics dashboard eg: 'config/prometheus/common_metrics.yml'", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetricsDashboard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "name", "description": "Human-readable name of the environment", "args": [ @@ -15119,6 +15146,33 @@ }, { "kind": "OBJECT", + "name": "MetricsDashboard", + "description": null, + "fields": [ + { + "name": "path", + "description": "Path to a file with the dashboard definition", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "Milestone", "description": "Represents a milestone.", "fields": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 6ed3c5a778e..e1375530bf4 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -324,6 +324,7 @@ Describes where code is deployed for a project | Name | Type | Description | | --- | ---- | ---------- | | `id` | ID! | ID of the environment | +| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment | | `name` | String! | Human-readable name of the environment | | `state` | String! | State of the environment, for example: available/stopped | @@ -815,6 +816,12 @@ Autogenerated return type of MergeRequestSetWip | `revision` | String! | Revision | | `version` | String! | Version | +## MetricsDashboard + +| Name | Type | Description | +| --- | ---- | ---------- | +| `path` | String | Path to a file with the dashboard definition | + ## Milestone Represents a milestone. diff --git a/doc/development/understanding_explain_plans.md b/doc/development/understanding_explain_plans.md index 48791e201eb..8c71a27540d 100644 --- a/doc/development/understanding_explain_plans.md +++ b/doc/development/understanding_explain_plans.md @@ -721,7 +721,7 @@ For example, in order to test new index you can do the following: Create the index: ```sql -exec CREATE INDEX index_projects_marked_for_deletion ON projects (marked_for_deletion_at) WHERE marked_for_deletion_at IS NOT NULL +exec CREATE INDEX index_projects_last_activity ON projects (last_activity_at) WHERE last_activity_at IS NOT NULL ``` Analyze the table to update its statistics: @@ -733,7 +733,7 @@ exec ANALYZE projects Get the query plan: ```sql -explain SELECT * FROM projects WHERE marked_for_deletion_at < CURRENT_DATE +explain SELECT * FROM projects WHERE last_activity_at < CURRENT_DATE ``` Once done you can rollback your changes: diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 4b07ecd2743..88a9bd40f07 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -309,6 +309,7 @@ The following tables outline the details of expected properties. | `label` | string | no, but highly encouraged | Defines the legend-label for the query. Should be unique within the panel's metrics. Can contain time series labels as interpolated variables. | | `query` | string | yes if `query_range` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) will be utilized. | | `query_range` | string | yes if `query` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query_range` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) will be utilized. | +| `step` | number | no, value is calculated if not defined | Defines query resolution step width in float number of seconds. Metrics on the same panel should use the same `step` value. | ##### Dynamic labels |