Browse Source

Update whats-new-in-v2.md

nopzor1200 10 years ago
parent
commit
360efdf71f
1 changed files with 82 additions and 70 deletions
  1. 82 70
      docs/sources/guides/whats-new-in-v2.md

+ 82 - 70
docs/sources/guides/whats-new-in-v2.md

@@ -12,41 +12,54 @@ be found in Grafana V2.0.
 
 
 If you are interested in how to migrate from Grafana V1.x to V2.0, please read our [Migration Guide](../installation/migrating_to2.md)
 If you are interested in how to migrate from Grafana V1.x to V2.0, please read our [Migration Guide](../installation/migrating_to2.md)
 
 
-## New backend
+## New backend server
 
 
-Grafana now ships with its own backend server. Graphs are still 100% client-side rendered, but the integrated server allows for much of
-the new functionality that 2.0 brings. The backend server is written in Go, has a full HTTP API, and is also completely open source.
+Grafana now ships with its own required backend server. Also completely open-source, it's written in Go and has a full HTTP API.
 
 
-In addition to new features, the backend server makes it much easier to set up and enjoy Grafana.
-Grafana 2.0 ships as a single binary with no dependencies, and we hope to extend support to more platforms.
-Authentication is built in, and Grafana is now capable of proxying connections to Data Sources.
-There are no longer any CORS (Cross Origin Resource Sharing) issues requiring messy workarounds.
-Elasticsearch is no longer required just to store dashboards.
+In addition to new features, the backend server makes it much easier to set up and enjoy Grafana. Grafana 2.0 now ships as cross platform binaries with no dependencies. Authentication is built in, and Grafana is now capable of proxying connections to Data Sources.  There are no longer any CORS (Cross Origin Resource Sharing) issues requiring messy workarounds. Elasticsearch is no longer required just to store dashboards.
+
+## User & Organization permissions
+
+All Dashboards and Data Sources are linked to an Organization (not to a User). Users are linked to
+Organizations via a role. That role can be:
+
+- `Viewer`: Can only view dashboards, not save / create them.
+- `Editor`: Can view, update and create dashboards.
+- `Admin`: Everything an Editor can plus edit and add data sources and organization users.
+
+> **Note** A `Viewer` can still view all metrics exposed through a data source, not only
+> the metrics used in already existing dashboards. That is because there are not
+> per series permissions in Graphite, InfluxDB or OpenTSDB.
+
+There are currently no permissions on individual dashboards.
+
+Read more about Grafanas new user model on the [Admin section](../reference/admin/)
 
 
 ## Dashboard Snapshot sharing
 ## Dashboard Snapshot sharing
+
 A Dashboard Snapshot is an easy way to create and share a URL for a stripped down, point-in-time version of any Dashboard.
 A Dashboard Snapshot is an easy way to create and share a URL for a stripped down, point-in-time version of any Dashboard.
 You can give this URL to anyone or everyone, and they can view the Snapshot even if they're not a User of your Grafana instance.
 You can give this URL to anyone or everyone, and they can view the Snapshot even if they're not a User of your Grafana instance.
-You can set an expiration time for any Snapshots you create. When you create a Snapshot, we strip some data, like
+
+You can set an expiration time for any Snapshots you create. When you create a Snapshot, we strip sensitive data, like
 panel metric queries, annotation and template queries and panel links. The data points displayed on
 panel metric queries, annotation and template queries and panel links. The data points displayed on
 screen for that specific time period in your Dashboard is saved in the JSON of the Snapshot itself.
 screen for that specific time period in your Dashboard is saved in the JSON of the Snapshot itself.
 
 
 Sharing a Snapshot is similar to sharing a link to a screenshot of your dashboard, only way better (they'll look great at any screen resolution, you can hover over series,
 Sharing a Snapshot is similar to sharing a link to a screenshot of your dashboard, only way better (they'll look great at any screen resolution, you can hover over series,
 even zoom in). Also they are fast to load as they aren't actually connected to any live Data Sources in any way.
 even zoom in). Also they are fast to load as they aren't actually connected to any live Data Sources in any way.
 
 
-They're a great way to communicate about a particular incident with specific people, or over the Internet. You can also use them to show off your dashboards.
+They're a great way to communicate about a particular incident with specific people who aren't Users of your Grafana instance. You can also use them to show off your dashboards over the Internet.
 
 
 ![](/img/v2/dashboard_snapshot_dialog.png)
 ![](/img/v2/dashboard_snapshot_dialog.png)
 
 
 ### Publish snapshots
 ### 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 publish snapshots locally or to [snapshot.raintank.io](http://snapshot.raintank.io). snapshot.raintank is a free service provided by [raintank](http://raintank.io) for hosting external Grafana snapshots.
+
+Either way, anyone with the link (and access to your Grafana instance for local snapshots) can view it.
 
 
 ## Panel time overrides & timeshift
 ## Panel time overrides & timeshift
 
 
-In Grafana v2.x you can now override the relative time range for individual panels. You can also add a
-time shift to individual panels. This allows you to show metrics from different time periods or days
-at the same time.
+In Grafana v2.x you can now override the relative time range for individual panels, causing them to be different than what is selected in the Dashboard time picker in the upper right. You can also add a time shift to individual panels. This allows you to show metrics from different time periods or days at the same time.
 
 
 ![](/img/v2/panel_time_override.jpg)
 ![](/img/v2/panel_time_override.jpg)
 
 
@@ -54,54 +67,62 @@ You control these overrides in panel editor mode and the new tab `Time Range`.
 
 
 ![](/img/v2/time_range_tab.jpg)
 ![](/img/v2/time_range_tab.jpg)
 
 
-Currently you can only override the dashboard time with relative time ranges, not absolute time ranges. When
-you zoom or change the dashboard time to a custom absolute time range the panel overrides will be disabled. The
-panel relative time override is only active when the dashboard time is also relative. The panel timeshift override
-however is always active, even when the dashboard time is absolute.
+When you zoom or change the Dashboard time to a custom absolute time range, all panel overrides will be disabled. The panel relative time override is only active when the dashboard time is also relative. The panel timeshift override however is always active, even when the dashboard time is absolute.
 
 
 The `Hide time override info` option allows you to hide the the override info text that is by default shown in the
 The `Hide time override info` option allows you to hide the the override info text that is by default shown in the
-upper right of a panel when overriden time range options.
+upper right of a panel when overridden time range options.
 
 
-## Panel IFrame embedding
+Currently you can only override the dashboard time with relative time ranges, not absolute time ranges. 
 
 
-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](http://snapshot.raintank.io). Try
-hovering or zooming on the panel below!
+## Panel iframe embedding
+
+You can embed a single panel on another web page or your own application using the panel share dialog. 
+
+Below you should see an iframe with a graph panel (taken from a Dashboard snapshot at [snapshot.raintank.io](http://snapshot.raintank.io). 
+
+Try hovering or zooming on the panel below!
 
 
 <iframe src="http://snapshot.raintank.io/dashboard/solo/snapshot/IQ7iZF00sHalq0Ffjv6OyclJSA1YHYV1?panelId=4&fullscreen" width="650" height="300" frameborder="0"></iframe>
 <iframe src="http://snapshot.raintank.io/dashboard/solo/snapshot/IQ7iZF00sHalq0Ffjv6OyclJSA1YHYV1?panelId=4&fullscreen" width="650" height="300" frameborder="0"></iframe>
 
 
+This feature makes it easy to include interactive visualizations from your Grafana instance anywhere you want.
+
 ## New dashboard top header
 ## New dashboard top header
 
 
+The top header has gotten a major streamlining in Grafana V2.0.
+
 <img class="no-shadow" src="/img/v2/v2_top_nav_annotated.png">
 <img class="no-shadow" src="/img/v2/v2_top_nav_annotated.png">
 
 
 1. `Side menubar toggle` Toggle the side menubar on or off. This allows you to focus on the data presented on the Dashboard. The side menubar provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources.
 1. `Side menubar toggle` Toggle the side menubar on or off. This allows you to focus on the data presented on the Dashboard. The side menubar provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources.
-2. `Dashboard dropdown` This main dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard, Import existing Dashboards, and manage Dashboard playlists.
-3. `Star Dashboard`: Star (or unstar) the current Dashboar. Starred Dashboards will show up on your own Home Dashboard by default, and are a convenient way to mark Dashboards that you're interested in.
+2. `Dashboard dropdown` The main dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard, Import existing Dashboards, and manage the Playlist.
+3. `Star Dashboard`: Star (or un-star) the current Dashboard. Starred Dashboards will show up on your own Home Dashboard by default, and are a convenient way to mark Dashboards that you're interested in.
 4. `Share Dashboard`: Share the current dashboard by creating a link or create a static Snapshot of it. Make sure the Dashboard is saved before sharing.
 4. `Share Dashboard`: Share the current dashboard by creating a link or create a static Snapshot of it. Make sure the Dashboard is saved before sharing.
-5. `Save dashboard`: Save the current Dashboard.
-6. `Settings`: Manage Dashboard settings and features such as Templating and Annotations.
+5. `Save dashboard`: Save the current Dashboard with the current name.
+6. `Settings`: Manage Dashboard settings and features such as Templating, Annotations and the name.
 
 
 > **Note** In Grafana v2.0 when you change the title of a dashboard and then save it it will no
 > **Note** In Grafana v2.0 when you change the title of a dashboard and then save it it will no
-> 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
+> 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
 
 
 ### New Side menubar
 ### New Side menubar
 
 
-The side menubar provides access to features such as User Preferences, Organizations, and Data Sources.
-If you have multiple Organizations, you can easily switch between them.
+The new side menubar provides access to features such as User Preferences, Organizations, and Data Sources.
+
+If you have multiple Organizations, you can easily switch between them here.
+
+The side menubar will become more useful as we build out additional functionality in Grafana 2.x
+
+You can easily collapse or re-open the side menubar at any time by clicking the Grafana icon in the top left. We never want to get in the way of the data.
 
 
 ## New search view & starring dashboards
 ## New search view & starring dashboards
 
 
 ![](/img/v2/dashboard_search.jpg)
 ![](/img/v2/dashboard_search.jpg)
 
 
-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.
+The dashboard search view has gotten a big overhaul. You can now see and filter by which dashboard you have personally starred.
 
 
 ## Logarithmic scale
 ## 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.
+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 (eg.
+latency, network traffic, and storage)
 
 
 ![](/img/v2/graph_logbase10_ms.png)
 ![](/img/v2/graph_logbase10_ms.png)
 
 
@@ -109,56 +130,47 @@ latency, network traffic or storage.
 
 
 ![](/img/v2/dashlist_starred.png)
 ![](/img/v2/dashlist_starred.png)
 
 
-There is one new panel in Grafana v2.0 and that is the `dashlist` panel that allows you to show your personal
-starred dashboards as well as do custom searches based on search strings or tags.
+The dashlist is a new panel in Grafana v2.0. It allows you to show your personal starred dashboards, as well as do custom searches based on search strings or tags. 
+
+dashlist is used on the new Grafana Home screen. It is included as a reference Panel and is useful to provide basic linking between Dashboards.
 
 
 ## Data Source proxy & admin views
 ## Data Source proxy & admin views
 
 
-Data sources in Grafana v2.0 are NOT defined in a config file but added through the UI. The backend can also
-handle proxying data source metric requests which meens that it is a lot easier to get started using Grafana with
-Graphite or OpenTSDB without having to spend time with nginx CORS (Cross origin resource sharing) work arounds.
+Data sources in Grafana v2.0 are no longer defined in a config file. Instead, they are added through the UI or the HTTP API.
 
 
-> **Note** For InfluxDB users: The data source proxy feature will
-> hide database user & password details from the frontend / browser.
+The backend can now proxy data from Data Sources, which means that it is a lot easier to get started using Grafana with Graphite or OpenTSDB without having to spend time with CORS (Cross origin resource sharing) work-arounds. 
 
 
-## Relative time now delay
-A commonly reported problem has been graphs dipping to zero at the the end, because metric data for
-the last interval has yet to be written to the Data Source. These graphs then "self correct" once the data comes in, but can look deceiving or alarming at times.
+In addition, connections to Data Sources can be better controlled and secured, and authentication information no longer needs to be exposed to the browser.
 
 
-You can avoid this problem by adding a `now delay` in `Dashboard Settings` > `Time Picker` tab. This will effectively cause Grafana to ignore the most recent data up to the set delay. The necessary delay will depend on how much latency you have in your collection pipeline.
+## Dashboard "now delay"
+
+A commonly reported problem has been graphs dipping to zero at the the end, because metric data for the last interval has yet to be written to the Data Source. These graphs then "self correct" once the data comes in, but can look deceiving or alarming at times.
+
+You can avoid this problem by adding a `now delay` in `Dashboard Settings` > `Time Picker` tab. This new feature will cause Grafana to ignore the most recent data up to the set delay. 
 ![](/img/v2/timepicker_now_delay.jpg)
 ![](/img/v2/timepicker_now_delay.jpg)
 
 
-## Overwrite protection
+The delay that may be necessary depends on how much latency you have in your collection pipeline.
 
 
-Grafana v2.0 will protect Users from accidentally overwriting another Users changes. Similar protections are in place if you try to create a new Dashboard with the same name as an existing one.
-These protections are only the first step; we will be building out additional capabilities around dashboard versioning and management in future versions of Grafana.
+## Dashboard overwrite protection
 
 
-![](/img/v2/overwrite_protection.jpg)
+Grafana v2.0 protects Users from accidentally overwriting each others Dashboard changes. Similar protections are in place if you try to create a new Dashboard with the same name as an existing one. 
 
 
-## User preferences
+![](/img/v2/overwrite_protection.jpg)
 
 
-If you open side menu (by clicking on the Grafana icon in the top header) you can access your profile page.
-Here you can update your user details, UI Theme and change password.
+These protections are only the first step; we will be building out additional capabilities around dashboard versioning and management in future versions of Grafana.
 
 
-## PNG rendering
-Grafana now supports server-side PNG rendering. From the Panel share dialog you now have access to a link that will render the Panel to a PNG image.
+## User preferences
 
 
-> **Note** This requires that your Data Source is accessible from your Grafana instance.
+If you open side menu (by clicking on the Grafana icon in the top header) you can access your Profile Page.
 
 
-![](/img/v2/share_dialog_image_highlight.jpg)
+Here you can update your user details, UI Theme, and change your password.
 
 
-## User & Organization permissions
+## Server-side Panel rendering
 
 
-All dashboards and data sources are linked to an organization (not to a user). Users are linked to
-Organizations via a role. That role can be:
+Grafana now supports server-side PNG rendering. From the Panel share dialog you now have access to a link that will render a particular Panel to a PNG image.
 
 
-- `Viewer`: Can only view dashboards, not save / create them.
-- `Editor`: Can view, update and create dashboards.
-- `Admin`: Everything an Editor can plus edit and add data sources and organization users.
+> **Note** This requires that your Data Source is accessible from your Grafana instance.
 
 
-> **Note** A `Viewer` can still view all metrics exposed through a data source, not only
-> the metrics used in already existing dashboards. That is because there are not
-> per series permissions in Graphite, InfluxDB or OpenTSDB.
+![](/img/v2/share_dialog_image_highlight.jpg)
 
 
-There are currently no permissions on individual dashboards.