-
Notifications
You must be signed in to change notification settings - Fork 31
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: Reorganization of data source how-to files #960
Changes from all commits
63cd7aa
44e465f
94a9394
4407a9f
037d71a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
josmperez marked this conversation as resolved.
Show resolved
Hide resolved
|
josmperez marked this conversation as resolved.
Show resolved
Hide resolved
|
josmperez marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -249,7 +249,7 @@ const response = getBackendSrv().fetch<TODO[]>({ | |||||
|
||||||
## Add authentication to your requests using the data proxy | ||||||
|
||||||
To learn about adding authentication to the data proxy, refer to our [documentation](./add-authentication-for-data-source-plugins.md). | ||||||
To learn about adding authentication to the data proxy, refer to our [documentation](../../how-to-guides/data-source-plugins/add-authentication-for-data-source-plugins.md). | ||||||
|
||||||
## Debug requests from the data proxy | ||||||
|
||||||
|
@@ -271,4 +271,4 @@ With this configuration, the Grafana server output shows the requests going out | |||||
|
||||||
## Send special headers using the data proxy | ||||||
|
||||||
You can send special headers using the data proxy. To learn about adding headers to the data proxy, refer to our [documentation](./add-authentication-for-data-source-plugins.md). | ||||||
You can send special headers using the data proxy. To learn about adding headers to the data proxy, refer to our [documentation](../../how-to-guides/data-source-plugins/add-annotations-for-data-source-plugins.md). | ||||||
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.
Suggested change
This changed the link to somewhere incorrect |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,9 @@ | ||||||
{ | ||||||
"position": 21, | ||||||
"label": "How-to guides", | ||||||
"customProps": { | ||||||
"description": "Learn how to perform common tasks with Grafana plugins." | ||||||
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.
Suggested change
|
||||||
}, | ||||||
"collapsible": true, | ||||||
"collapsed": true | ||||||
} |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,8 @@ | ||||||
{ | ||||||
"label": "Data source plugins", | ||||||
"customProps": { | ||||||
"description": "Learn how to perform tasks in Grafana data source plugin development." | ||||||
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.
Suggested change
|
||||||
}, | ||||||
"collapsible": true, | ||||||
"collapsed": true | ||||||
} |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,16 +1,14 @@ | ||||||
--- | ||||||
id: enable-for-annotations | ||||||
title: Enable annotations | ||||||
description: Add support for annotations in your plugin. | ||||||
id: add-annotations | ||||||
title: Add annotations | ||||||
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.
Suggested change
|
||||||
description: Add support for annotations in your data source plugin. | ||||||
keywords: | ||||||
- grafana | ||||||
- plugins | ||||||
- plugin | ||||||
- annotations | ||||||
--- | ||||||
|
||||||
# Enable annotations | ||||||
|
||||||
You can add support to your plugin for annotations that will insert information into Grafana alerts. This guide explains how to add support for [annotations](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/) to a data source plugin. | ||||||
|
||||||
## Support annotations in your data source plugin | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,6 +1,6 @@ | ||||||
--- | ||||||
id: add-logs-metrics-traces-for-backend-plugins | ||||||
title: Add logs, metrics and traces for backend plugins | ||||||
id: add-logs-metrics-traces | ||||||
title: Add logs, metrics, and traces | ||||||
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. If changing the title we need to make it clearer on the page that this requires a backend component |
||||||
description: How to add logs, metrics and traces for backend plugins. | ||||||
keywords: | ||||||
- grafana | ||||||
|
@@ -16,8 +16,6 @@ keywords: | |||||
- back-end | ||||||
--- | ||||||
|
||||||
# Add logs, metrics and traces for backend plugins | ||||||
|
||||||
Adding [logs](#logs), [metrics](#metrics) and [traces](#traces) for backend plugins makes it easier to diagnose and resolve issues for both plugin developers and Grafana operators. This document provides guidance, conventions and best practices to help you effectively instrument your plugins, as well as how to access this data when the plugin is installed. | ||||||
|
||||||
## Logs | ||||||
|
@@ -114,7 +112,7 @@ Use a contextual logger to automatically include additional key-value pairs atta | |||||
|
||||||
:::note | ||||||
|
||||||
Make sure you are using at least [grafana-plugin-sdk-go v0.186.0](https://github.com/grafana/grafana-plugin-sdk-go/releases/tag/v0.186.0). See [Update the Go SDK](../develop-a-plugin/work-with-backend#update-the-go-sdk) for update instructions. | ||||||
Make sure you are using at least [grafana-plugin-sdk-go v0.186.0](https://github.com/grafana/grafana-plugin-sdk-go/releases/tag/v0.186.0). Refer to [Update the Go SDK](../../key-concepts/backend-plugins/grafana-plugin-sdk-for-go) for update instructions. | ||||||
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.
Suggested change
|
||||||
|
||||||
::: | ||||||
|
||||||
|
@@ -396,7 +394,7 @@ If tracing is disabled in Grafana, `backend.DefaultTracer()` returns a no-op tra | |||||
|
||||||
:::note | ||||||
|
||||||
Make sure you are using at least [`grafana-plugin-sdk-go v0.157.0`](https://github.com/grafana/grafana-plugin-sdk-go/releases/tag/v0.157.0). Refer to [Update the Go SDK](../develop-a-plugin/work-with-backend#update-the-go-sdk) for update instructions. | ||||||
Make sure you are using at least [`grafana-plugin-sdk-go v0.157.0`](https://github.com/grafana/grafana-plugin-sdk-go/releases/tag/v0.157.0). Refer to [Update the Go SDK](../../create-a-plugin/develop-a-plugin/work-with-backend) for update instructions. | ||||||
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.
Suggested change
|
||||||
|
||||||
::: | ||||||
|
||||||
|
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.
I think if we're removing backend-plugins from the name/link, then we need to update the page to make it clear that a backend is required
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.
i don't follow this suggestion. On the page docusaurus/docs/how-to-guides/data-source-plugins/add-logs-metrics-traces-for-backend-plugins.md, it is clearly marked as related to backend plugins. For example, the opening senence starts "Adding logs, metrics and traces for backend plugins..."