Updated docs: whats new in 2.0, added sharing reference docs page, #1571

2025-01-01 11:47:05 -06:00 · 2015-03-26 17:55:07 +01:00 · 2015-03-26 17:55:07 +01:00 · 165647184d
commit 165647184d
parent 2ca86b6085
6 changed files with 75 additions and 13 deletions
--- a/conf/defaults.ini
+++ b/conf/defaults.ini
@ -45,7 +45,7 @@ provider = file
 ; memory: not have any config yet
 ; file: session file path, e.g. `data/sessions`
 ; redis: config like redis server addr, poolSize, password, e.g. `127.0.0.1:6379,100,grafana`
-; mysql: go-sql-driver/mysql dsn config string, e.g. `root:password@/session_table`
+; mysql: go-sql-driver/mysql dsn config string, e.g. `user:password@tcp(127.0.0.1)/database_name`
 provider_config = data/sessions
 ; Session cookie name
 cookie_name = grafana_sess
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@ -40,6 +40,7 @@ pages:
 - ['reference/graph.md', 'Reference', 'Graph Panel']
 - ['reference/singlestat.md', 'Reference', 'Singlestat Panel']
 - ['reference/dashlist.md', 'Reference', 'Dashlist Panel']
+- ['reference/sharing.md', 'Reference', 'Sharing']
 - ['reference/annotations.md', 'Reference', 'Annotations']
 - ['reference/timerange.md', 'Reference', 'Time range controls']
 - ['reference/search.md', 'Reference', 'Dashboard Search']
--- a/docs/sources/guides/changes_in_v2.md
+++ b/docs/sources/guides/changes_in_v2.md
@ -32,6 +32,19 @@ This is a guide that descriptes some of changes and new features that can be fou
 > longer create a new dashboard. It will just change the name for the current dashboard.
 > To change name and create a new dashboard use the `Save As...` menu option

+## Dashboard Snapshot sharing
+A dashboard snapshot is an instant way to share an interactive dashboard publicly. When created, we <strong>strip sensitive data</strong> like queries
+(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard
+snapshots can be accessed by anyone who has the link and can reach the URL.
+
+![](/img/v2/dashboard_snapshot_dialog.png)
+
+### Publish snapshots
+You can publish snapshots to you local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The later is a free service
+that is provided by [Raintank](http://raintank.io) that allows you to publish dashboard snapshots to an external grafana instance.
+The same rules still apply, anyone with the link can view it. You can set an expiration time if you want the snapshot to be removed
+after a certain time period.
+
 ## Panel time overrides & timeshift

 In Grafana v2.x you can now override the relative time range for individual panels. You can also add a
@ -59,6 +72,14 @@ upper right of a panel when overriden time range options.
 The dashboard search view has received a big UI update and polish. You can now see and filter by which dashboard
 you have personally starred.

+## Logarithmic scale
+
+The Graph panel now supports 3 logarithmic scales, `log base 10`, `log base 32`, `log base 1024`. Logarithmic y-axis
+scales are very useful when rendering many series of different order of magnitude on the same scale. For example
+latency, network traffic or storage.
+
+![](/img/v2/graph_logbase10_ms.png)
+
 ## Dashlist panel

 ![](/img/v2/dashlist_starred.png)
@ -118,3 +139,10 @@ Organizations via a role. That role can be:
 > per series permissions in Graphite, InfluxDB or OpenTSDB.

 There are currently no permissions on individual dashboards.
+
+## Panel IFrame embedding
+
+You can embed a single panel on another web page using the panel share dialog. Below you should see an iframe
+with a graph panel (taken from dashoard snapshot at [snapshot.raintank.io](snapshot.raintank.io).
+
+<iframe src="http://snapshot.raintank.io/dashboard/solo/snapshot/UtvRYDv650fHOV2jV5QlAQhLnNOhB5ZN?panelId=4&fullscreen&from=1427385145990&to=1427388745990" width="650" height="300" frameborder="0"></iframe>
--- a/docs/sources/installation/configuration.md
+++ b/docs/sources/installation/configuration.md
@ -184,7 +184,7 @@ Valid values are "memory", "file", "mysql", 'postgres'. Default is "memory".
 This option should be configured differently depending on what type of session provider you have configured.

 - **file:** session file path, e.g. `data/sessions`
- **mysql:** go-sql-driver/mysql dsn config string, e.g. `root:password@/session_table`
+- **mysql:** go-sql-driver/mysql dsn config string, e.g. `user:password@tcp(127.0.0.1)/database_name`

 if you use mysql or postgres as session store you need to create the session table manually.
 Mysql Example:
--- a/docs/sources/reference/sharing.md
+++ b/docs/sources/reference/sharing.md
@ -0,0 +1,44 @@
+----
+page_title: Sharing
+page_description: Sharing
+page_keywords: grafana, sharing, guide, documentation
+---
+
+# Sharing features
+Grafana provides a number of ways to share a dashboard or a specfic panel to other users within your
+organization. It also provides ways to publish interactive snapshots that can be accessed by external partners.
+
+## Share dashboard
+Share a dashboard via the share icon in the top nav. This opens the share dialog where you
+can get a link to the current dashboard with the current selected time range and template variables. If you have
+made changes to the dashboard, make sure those are saved before sending the link.
+
+### Dashboard snapshot
+
+A dashboard snapshot is an instant way to share an interactive dashboard publicly. When created, we <strong>strip sensitive data</strong> like queries
+(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard
+snapshots can be accessed by anyone who has the link and can reach the URL.
+
+![](/img/v2/dashboard_snapshot_dialog.png)
+
+### Publish snapshots
+You can publish snapshots to you local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The later is a free service
+that is provided by [Raintank](http://raintank.io) that allows you to publish dashboard snapshots to an external grafana instance.
+The same rules still apply, anyone with the link can view it. You can set an expiration time if you want the snapshot to be removed
+after a certain time period.
+
+## Share Panel
+Click a panel title to open the panel menu, then click share in the panel menu to open the Share Panel dialog. Here you
+have access to a link that will take you to exactly this panel with the current time range and selected template variables.
+You also get a link to service side rendered PNG of the panel. Useful if you want to shara image of the panel.
+
+### Embed Panel
+You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use.
+
+Example:
+
+```html
+<iframe src="http://snapshot.raintank.io/dashboard/solo/snapshot/UtvRYDv650fHOV2jV5QlAQhLnNOhB5ZN?panelId=4&fullscreen&from=1427385145990&to=1427388745990" width="650" height="300" frameborder="0"></iframe>
+```
+Below there should be an interactive Grafana graph embedded in an iframe:
+<iframe src="http://snapshot.raintank.io/dashboard/solo/snapshot/UtvRYDv650fHOV2jV5QlAQhLnNOhB5ZN?panelId=4&fullscreen&from=1427385145990&to=1427388745990" width="650" height="300" frameborder="0"></iframe>
--- a/src/app/features/dashboard/partials/shareDashboard.html
+++ b/src/app/features/dashboard/partials/shareDashboard.html
@ -84,17 +84,6 @@
 					</ul>
 					<div class="clearfix"></div>
 				</div>
-				<!-- <div class="tight&#45;form"> -->
-				<!-- 	<ul class="tight&#45;form&#45;list"> -->
-				<!-- 		<li class="tight&#45;form&#45;item" style="width: 110px"> -->
-				<!-- 			Access -->
-				<!-- 		</li> -->
-				<!-- 		<li> -->
-				<!-- 			<select class="input&#45;small tight&#45;form&#45;input last" style="width: 211px" ng&#45;model="snapshot.access" ng&#45;options="f.value as f.text for f in accessOptions"></select> -->
-				<!-- 		</li> -->
-				<!-- 	</ul> -->
-				<!-- 	<div class="clearfix"></div> -->
-				<!-- </div> -->
 			</div>

 			<div class="gf-form" ng-if="step === 2" style="margin-top: 55px">