diff options
| author | syasonik <syasonik@gitlab.com> | 2019-05-06 17:10:42 -0500 |
|---|---|---|
| committer | Jose Vargas <jvargas@gitlab.com> | 2019-07-08 12:37:04 -0500 |
| commit | ed96564be2c2f5e24e11c70c7ad0652af0776e1a (patch) | |
| tree | 8a0db9be00bafb3a25f9a504dc8c229cd5070646 | |
| parent | 924634492a042e6ba6e802f1856d8227a8803f71 (diff) | |
| download | gitlab-ce-project-dashboards-docs.tar.gz | |
Remove chart-specific contentproject-dashboards-docs
| -rw-r--r-- | doc/user/project/integrations/prometheus.md | 6 |
1 files changed, 1 insertions, 5 deletions
diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 538a4ae2085..cdced4b3737 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -124,9 +124,6 @@ To specify a variable in a query, enclose it in curly braces with a leading perc All projects include a GitLab-defined system dashboard, which includes a few key metrics. Optionally, additional dashboards can also be defined by including configuration files in the project repository under `.gitlab/dashboards`. Configuration files nested under subdirectories will not be available in the UI. Each file should define the layout of the dashboard and the prometheus queries used to populate data. Dashboards can be selected from the dropdown in the UI. -<!-- TODO: --> -<!-- [INSERT IMAGE OF DROPDOWN HERE] --> - #### Relationship to Custom Metrics [Custom Metrics](#adding-additional-metrics-premium) are defined through the UI and, at this point, are unique from metrics defined in dashboard configuration files. Custom Metrics will appear on the system dashboard, as well as support alerting, whereas metrics defined in configuration files do not yet support alerts. @@ -171,12 +168,11 @@ The above sample dashboard would display a single area chart. The following sect ##### Panel Properties | Property | Type | Required? | Meaning | | ------ | ------ | ------ | ------- | -| `type` | enum | optional, defaults to `area-chart` | Specifies the chart type to use. Must be one of `area-chart`, `single-stat`, `line-chart`, `column-chart`, and `heatmap`. | +| `type` | enum | optional, defaults to `area-chart` | Specifies the chart type to use. Only `area-chart` is currently supported. | | `title` | string | required | Heading for the panel. | | `y_label` | string | optional, but highly encouraged | Y-Axis label for the panel. | | `weight` | number | optional, defaults to order in file | Order to appear within the grouping, higher priority will be higher on the page. Numbers do not need to be consecutive. | | `metrics` | array | required | The metrics which should be displayed in the panel. | -| `presentation` | enum | optional, defaults to `stacked` | Only used in the `column-chart` panel type. Must be one of `stacked` or `tiled`. | ##### Metric Properties | Property | Type | Required? | Meaning | |