-
Notifications
You must be signed in to change notification settings - Fork 12k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Minor edits to the README and several md files #19238
Changes from 10 commits
117596b
0e3ef48
dfe9878
208fb43
b89ab22
81432dd
28505c1
aae9937
ea5b4e7
bd2861e
717156a
3f8b6a7
e087d40
04f55e5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,9 +39,9 @@ Supported auth providers: | |
* [GitHub OAuth]({{< relref "auth/github.md#team-sync-enterprise-only" >}}) | ||
* [Auth Proxy]({{< relref "auth/auth-proxy.md#team-sync-enterprise-only">}}) | ||
|
||
### Datasource Permissions | ||
### Data Source Permissions | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should probably be in sentence case |
||
|
||
Datasource permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "permissions/datasource_permissions.md" >}}). | ||
Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "permissions/datasource_permissions.md" >}}). | ||
|
||
|
||
### Premium Plugins | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,7 +22,7 @@ Grafana ships with built in support for CloudWatch. You just have to add it as a | |
3. Click the `+ Add data source` button in the top header. | ||
4. Select `Cloudwatch` from the *Type* dropdown. | ||
|
||
> NOTE: If at any moment you have issues with getting this datasource to work and Grafana is giving you undescriptive errors then don't | ||
> NOTE: If at any moment you have issues with getting this data source to work and Grafana is giving you undescriptive errors then don't | ||
forget to check your log file (try looking in /var/log/grafana/grafana.log). | ||
|
||
Name | Description | ||
|
@@ -136,11 +136,11 @@ types of template variables. | |
|
||
### Query variable | ||
|
||
CloudWatch Datasource Plugin provides the following queries you can specify in the `Query` field in the Variable | ||
CloudWatch data source plugin provides the following queries you can specify in the `Query` field in the Variable | ||
edit view. They allow you to fill a variable's options list with things like `region`, `namespaces`, `metric names` | ||
and `dimension keys/values`. | ||
|
||
In place of `region` you can specify `default` to use the default region configured in the datasource for the query, | ||
In place of `region` you can specify `default` to use the default region configured in the data source for the query, | ||
e.g. `metrics(AWS/DynamoDB, default)` or `dimension_values(default, ..., ..., ...)`. | ||
|
||
Read more about the available dimensions in the [CloudWatch Metrics and Dimensions Reference](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html). | ||
|
@@ -251,17 +251,17 @@ it costs $0.01 per 1,000 GetMetricStatistics or ListMetrics requests. For each q | |
issue a GetMetricStatistics request and every time you pick a dimension in the query editor | ||
Grafana will issue a ListMetrics request. | ||
|
||
## Configure the Datasource with Provisioning | ||
## Configure the Data Source with Provisioning | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This heading should also be sentence case |
||
|
||
It's now possible to configure datasources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
It's now possible to configure datas ources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
|
||
Here are some provisioning examples for this datasource. | ||
Here are some provisioning examples for this data source. | ||
|
||
Using a credentials file | ||
```yaml | ||
apiVersion: 1 | ||
|
||
datasources: | ||
data sources: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is an example of a YAML file, which would be considered code in this case. With this change, the YAML is not valid anymore, so we should leave this as is. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Got it! Will not touch yaml examples. |
||
- name: Cloudwatch | ||
type: cloudwatch | ||
jsonData: | ||
|
@@ -274,7 +274,7 @@ Using `accessKey` and `secretKey` | |
```yaml | ||
apiVersion: 1 | ||
|
||
datasources: | ||
data sources: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. YAML again. This should not be changed. |
||
- name: Cloudwatch | ||
type: cloudwatch | ||
jsonData: | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -51,7 +51,7 @@ http.cors.allow-origin: "*" | |
|
||
### Index settings | ||
|
||
![Elasticsearch Datasource Details](/img/docs/elasticsearch/elasticsearch_ds_details.png) | ||
![Elasticsearch data source Details](/img/docs/elasticsearch/elasticsearch_ds_details.png) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sentence case for the image caption. |
||
|
||
Here you can specify a default for the `time field` and specify the name of your Elasticsearch index. You can use | ||
a time pattern for the index name or a wildcard. | ||
|
@@ -190,17 +190,17 @@ Finally, press the `Enter` key or the `Run Query` button to display your logs. | |
|
||
Once the result is returned, the log panel shows a list of log rows and a bar chart where the x-axis shows the time and the y-axis shows the frequency/count. | ||
|
||
Note that the fields used for log message and level is based on an [optional datasource configuration](#logs-beta). | ||
Note that the fields used for log message and level is based on an [optional data source configuration](#logs-beta). | ||
|
||
### Filter Log Messages | ||
|
||
Optionally enter a lucene query into the query field to filter the log messages. For example, using a default Filebeat setup you should be able to use `fields.level:error` to only show error log messages. | ||
|
||
## Configure the Datasource with Provisioning | ||
## Configure the Data Source with Provisioning | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sentence case |
||
|
||
It's now possible to configure datasources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
|
||
Here are some provisioning examples for this datasource. | ||
Here are some provisioning examples for this data source. | ||
|
||
```yaml | ||
apiVersion: 1 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -150,11 +150,11 @@ queries via the Dashboard menu / Annotations view. | |
Graphite supports two ways to query annotations. A regular metric query, for this you use the `Graphite query` textbox. A Graphite events query, use the `Graphite event tags` textbox, | ||
specify a tag or wildcard (leave empty should also work) | ||
|
||
## Configure the Datasource with Provisioning | ||
## Configure the Data Source with Provisioning | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sentence case |
||
|
||
It's now possible to configure datasources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
|
||
Here are some provisioning examples for this datasource. | ||
Here are some provisioning examples for this data source. | ||
|
||
```yaml | ||
apiVersion: 1 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -216,11 +216,11 @@ For InfluxDB you need to enter a query like in the above example. You need to ha | |
part. If you only select one column you will not need to enter anything in the column mapping fields. The | ||
Tags field can be a comma separated string. | ||
|
||
## Configure the Datasource with Provisioning | ||
## Configure the Data Source with Provisioning | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sentence case |
||
|
||
It's now possible to configure datasources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) | ||
|
||
Here are some provisioning examples for this datasource. | ||
Here are some provisioning examples for this dat asource. | ||
|
||
```yaml | ||
apiVersion: 1 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the S be capitalized here?