From ae08386ce3c6631e41c6f1d095f77e76ce0c75e5 Mon Sep 17 00:00:00 2001 From: bergquist Date: Mon, 16 Jan 2017 11:13:52 +0100 Subject: [PATCH] docs(testdata): adds docs page about test datasource --- docs/sources/features/datasources/testdata.md | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 docs/sources/features/datasources/testdata.md diff --git a/docs/sources/features/datasources/testdata.md b/docs/sources/features/datasources/testdata.md new file mode 100644 index 00000000000..4e55ed9a5ed --- /dev/null +++ b/docs/sources/features/datasources/testdata.md @@ -0,0 +1,55 @@ ++++ +title = "Testdata Panel" +keywords = ["grafana", "dashboard", "documentation", "panels", "testdata"] +type = "docs" +[menu.docs] +name = "Test data" +parent = "datasources" +weight = 2 ++++ + + +# Test data Panel + + > NOTE: This panel is disable by default. + +## Purpose +The purpose of this data sources is to make it easier to create fake data for any panel. +Using `Grafana TestData` you can build your own time series and have any panel render it. +This make is much easier to verify functionally since the data can be shared very + +## Enable + +`Grafana TestData` is not enabled by default. To enable it you have to go to `/plugins/testdata/edit` and click the enable button. + +## Create mock data. + +Once `Grafana TestData` is enabled you use it as a datasource in the metric panel. + +![](/img/docs/v41/test_data_add.png) + +## Scenarios + +You can now choose different scenario that you want rendered in the drop down menu. If you have scenarios that you think should be added, please add them to `` and submit a pull request. + +## CSV + +The comma separated values scenario is the most powerful one since it lets you create any kind of graph you like. +Once you provided the numbers `Grafana TestData` will distribute them evenly based on the time range of your query. + +![](/img/docs/v41/test_data_csv_example.png) + + +## Dashboards + +`Grafana TestData` also contains some dashboards with example. `/plugins/testdata/edit` + +### Commit updates to the dashboards + +If you want to submit a change to one of the current dashboards bundled with `Grafana TestData` you have to update the revision property. +Otherwise the dashboard will not be updated automatically for other Grafana users. + +## Using test data in issues + +If you post an issue on github regarding time series data or rendering of time series data we strongly advice you to use this data source to replicate the data. +That makes it much easier for the developers to replicate and solve the issue you have.