docs: nav related updates for data sources (#66080)

* nav related text updates for data sources

* fixed table rows
This commit is contained in:
Isabel 2023-04-06 12:45:45 -04:00 committed by GitHub
parent 3d589cbed9
commit 6a91f1a9b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 92 additions and 63 deletions

View File

@ -46,7 +46,8 @@ By default, data sources in an organization can be queried by any user in that o
You can assign data source permissions to users, teams, and roles which will allow access to query or edit the data source. You can assign data source permissions to users, teams, and roles which will allow access to query or edit the data source.
1. Navigate to **Administration > Data sources**. 1. Click **Connections** in the left-side menu.
1. Under Your connections, click **Data sources**.
1. Select the data source to which you want to assign permissions. 1. Select the data source to which you want to assign permissions.
1. On the Permissions tab, click **Add a permission**. 1. On the Permissions tab, click **Add a permission**.
1. Select **User**, **Team**, or **Role**. 1. Select **User**, **Team**, or **Role**.
@ -58,7 +59,8 @@ You can assign data source permissions to users, teams, and roles which will all
### Edit data source permissions for users, teams, or roles ### Edit data source permissions for users, teams, or roles
1. Navigate to **Administration > Data sources**. 1. Click **Connections** in the left-side menu.
1. Under Your connections, click **Data sources**.
1. Select the data source for which you want to edit permissions. 1. Select the data source for which you want to edit permissions.
1. On the Permissions tab, find the user, team, or role permission you want to update. 1. On the Permissions tab, find the user, team, or role permission you want to update.
1. Select a different option in the **Permission** dropdown. 1. Select a different option in the **Permission** dropdown.
@ -67,7 +69,8 @@ You can assign data source permissions to users, teams, and roles which will all
### Remove data source permissions for users, teams, or roles ### Remove data source permissions for users, teams, or roles
1. Navigate to **Administration > Data sources**. 1. Click **Connections** in the left-side menu.
1. Under Your connections, click **Data sources**.
1. Select the data source from which you want to remove permissions. 1. Select the data source from which you want to remove permissions.
1. On the Permissions tab, find the user, team, or role permission you want to remove. 1. On the Permissions tab, find the user, team, or role permission you want to remove.
1. Click the **X** next to the permission. 1. Click the **X** next to the permission.
@ -122,9 +125,10 @@ You must be an Org admin or Grafana admin to enable query caching for a data sou
By default, data source queries are not cached. To enable query caching for a single data source: By default, data source queries are not cached. To enable query caching for a single data source:
1. On the left-side menu, click **Administration > Data sources**. 1. Click **Connections** in the left-side menu.
1. Under Your Connections, click **Data sources**.
1. In the data source list, click the data source that you want to turn on caching for. 1. In the data source list, click the data source that you want to turn on caching for.
1. Open the Cache tab. 1. Go to the Cache tab.
1. Click **Enable**. 1. Click **Enable**.
1. (Optional) Choose custom TTLs for the data source's queries and resources caching. If you skip this step, then Grafana uses the default TTL. 1. (Optional) Choose custom TTLs for the data source's queries and resources caching. If you skip this step, then Grafana uses the default TTL.
@ -140,9 +144,10 @@ To configure global settings for query caching, refer to the [Query caching sect
To disable query caching for a single data source: To disable query caching for a single data source:
1. On the left-side menu, click **Administration > Data sources**. 1. Click **Connections** in the left-side menu.
1. Under Your Connections, click **Data sources**.
1. In the data source list, click the data source that you want to turn off caching for. 1. In the data source list, click the data source that you want to turn off caching for.
1. In the Cache tab, click **Disable**. 1. On the Cache tab, click **Disable**.
To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached.
@ -152,7 +157,8 @@ If you experience performance issues or repeated queries become slower to execut
> **Note:** This action impacts all cache-enabled data sources. If you are using Memcached, the system clears all data from the Memcached instance. > **Note:** This action impacts all cache-enabled data sources. If you are using Memcached, the system clears all data from the Memcached instance.
1. On the left-side menu, click **Administration > Data sources**. 1. Click **Connections** in the left-side menu.
1. Under Your Connections, click **Data sources**.
1. In the data source list, click the data source that you want to clear the cache for. 1. In the data source list, click the data source that you want to clear the cache for.
1. In the Cache tab, click **Clear cache**. 1. In the Cache tab, click **Clear cache**.

View File

@ -28,24 +28,25 @@ When using Prometheus, contact points and notification policies are read-only in
## Configure the data source ## Configure the data source
**To access the data source configuration page:** To configure basic settings for the data source, complete the following steps:
1. Select the **Data sources** section from the **Administration** menu 1. Click **Connections** in the left-side menu.
2. Select the **Alertmanager** data source 1. Under Your connections, click **Data sources**.
1. Enter `Alertmanager` in the search bar.
1. Click **Alertmanager**.
Set the data source's basic configuration options carefully: The **Settings** tab of the data source is displayed.
| Name | Description | 1. Set the data source's basic configuration options:
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | Sets the name you use to refer to the data source | | Name | Description |
| **Default** | Sets whether the data source is pre-selected for new panels and queries | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Alertmanager** | | | **Name** | Sets the name you use to refer to the data source |
| **Implementation** | Alertmanager implementation. **Mimir**, **Cortex,** and **Prometheus** are supported | | **Default** | Sets whether the data source is pre-selected for new panels and queries |
| **Receive Grafana Alerts** | When enabled the Alertmanager receives alert instances from Grafana-managed alert rules. **Important:** It works only if Grafana alerting is configured to send its alert instances to external Alertmanagers | | **Alertmanager Implementation** | Alertmanager implementation. **Mimir**, **Cortex,** and **Prometheus** are supported |
| **HTTP** | | | **Receive Grafana Alerts** | When enabled the Alertmanager receives alert instances from Grafana-managed alert rules. **Important:** It works only if Grafana alerting is configured to send its alert instances to external Alertmanagers |
| **URL** | Sets the HTTP protocol, IP, and port of your Alertmanager instance, such as `https://alertmanager.example.org:9093` | | **HTTP URL** | Sets the HTTP protocol, IP, and port of your Alertmanager instance, such as `https://alertmanager.example.org:9093` |
| **Access** | Only **Server** access mode is functional | | **Access** | Only **Server** access mode is functional |
| | |
## Provision the Alertmanager data source ## Provision the Alertmanager data source

View File

@ -31,11 +31,12 @@ Once you've added the data source, you can [configure it]({{< relref "#configure
## Configure the data source ## Configure the data source
**To access the data source configuration page:** 1. Click **Connections** in the left-side menu.
1. Under Your connections, click **Data sources**.
1. Enter `CloudWatch` in the search bar.
1. Click **CloudWatch**.
1. Hover the cursor over the **Configuration** (gear) icon. The **Settings** tab of the data source is displayed.
1. Select **Data Sources**.
1. Select the CloudWatch data source.
### Configure AWS authentication ### Configure AWS authentication

View File

@ -24,26 +24,29 @@ Once you've added the Graphite data source, you can [configure it]({{< relref "#
## Configure the data source ## Configure the data source
**To access the data source configuration page:** To configure basic settings for the data source, complete the following steps:
1. Hover the cursor over the **Configuration** (gear) icon. 1. Click **Connections** in the left-side menu.
1. Select **Data Sources**. 1. Under Your connections, click **Data sources**.
1. Select the Graphite data source. 1. Enter `Graphite` in the search bar.
1. Click **Graphite**.
Set the data source's basic configuration options carefully: The **Settings** tab of the data source is displayed.
| Name | Description | 1. Set the data source's basic configuration options:
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Name** | Sets the name you use to refer to the data source in panels and queries. | | Name | Description |
| **Default** | Sets whether the data source is pre-selected for new panels. You can set only one default data source per organization. | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **URL** | Sets the HTTP protocol, IP, and port of your graphite-web or graphite-api installation. | | **Name** | Sets the name you use to refer to the data source in panels and queries. |
| **Auth** | For details, refer to [Configure Authentication]({{< relref "../../setup-grafana/configure-security/configure-authentication/" >}}). | | **Default** | Sets whether the data source is pre-selected for new panels. You can set only one default data source per organization. |
| **Basic Auth** | Enables basic authentication to the data source. | | **URL** | Sets the HTTP protocol, IP, and port of your graphite-web or graphite-api installation. |
| **User** | Sets the user name for basic authentication. | | **Auth** | For details, refer to [Configure Authentication]({{< relref "../../setup-grafana/configure-security/configure-authentication/" >}}). |
| **Password** | Sets the password for basic authentication. | | **Basic Auth** | Enables basic authentication to the data source. |
| **Custom HTTP Headers** | Click **Add header** to add a custom HTTP header. | | **User** | Sets the user name for basic authentication. |
| **Header** | Defines the custom header name. | | **Password** | Sets the password for basic authentication. |
| **Value** | Defines the custom header value. | | **Custom HTTP Headers** | Click **Add header** to add a custom HTTP header. |
| **Header** | Defines the custom header name. |
| **Value** | Defines the custom header value. |
You can also configure settings specific to the Graphite data source: You can also configure settings specific to the Graphite data source:

View File

@ -18,16 +18,25 @@ Grafana ships with built-in support for Parca, a continuous profiling OSS databa
## Configure the Parca data source ## Configure the Parca data source
To access Parca settings, click the **Configuration** (gear) icon, then click **Data Sources** > **Parca**. To configure basic settings for the data source, complete the following steps:
| Name | Description | 1. Click **Connections** in the left-side menu.
| ------------ | ------------------------------------------------------------------ | 1. Under Your connections, click **Data sources**.
| `Name` | A name to specify the data source in panels, queries, and Explore. | 1. Enter `Parca` in the search bar.
| `Default` | The default data source will be pre-selected for new panels. | 1. Click **Parca**.
| `URL` | The URL of the Parca instance, e.g., `http://localhost:4100` |
| `Basic Auth` | Enable basic authentication to the Parca data source. | The **Settings** tab of the data source is displayed.
| `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. | 1. Set the data source's basic configuration options:
| Name | Description |
| ------------ | ------------------------------------------------------------------ |
| `Name` | A name to specify the data source in panels, queries, and Explore. |
| `Default` | The default data source will be pre-selected for new panels. |
| `URL` | The URL of the Parca instance, e.g., `http://localhost:4100` |
| `Basic Auth` | Enable basic authentication to the Parca data source. |
| `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. |
## Querying ## Querying

View File

@ -18,17 +18,26 @@ Grafana ships with built-in support for Phlare, a horizontally scalable, highly-
## Configure the Phlare data source ## Configure the Phlare data source
To access Phlare settings, click the **Configuration** (gear) icon, then click **Data Sources** > **Phlare**. To configure basic settings for the data source, complete the following steps:
| Name | Description | 1. Click **Connections** in the left-side menu.
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | 1. Under Your connections, click **Data sources**.
| `Name` | A name to specify the data source in panels, queries, and Explore. | 1. Enter `Phlare` in the search bar.
| `Default` | The default data source will be pre-selected for new panels. | 1. Click **Phlare**.
| `URL` | The URL of the Phlare instance, e.g., `http://localhost:4100` |
| `Basic Auth` | Enable basic authentication to the Phlare data source. | The **Settings** tab of the data source is displayed.
| `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. | 1. Set the data source's basic configuration options:
| `Minimal step` | Similar to Prometheus, Phlare scrapes profiles at certain intervals. To prevent querying at smaller interval use Minimal step same or higher than your Phlare scrape interval. |
| Name | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Name` | A name to specify the data source in panels, queries, and Explore. |
| `Default` | The default data source will be pre-selected for new panels. |
| `URL` | The URL of the Phlare instance, e.g., `http://localhost:4100` |
| `Basic Auth` | Enable basic authentication to the Phlare data source. |
| `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. |
| `Minimal step` | Similar to Prometheus, Phlare scrapes profiles at certain intervals. To prevent querying at smaller interval use Minimal step same or higher than your Phlare scrape interval. |
## Querying ## Querying