1.25.0 release

Author: baumandm

CHANGELOG.md

@@ -1,3 +1,23 @@
+# 1.25.0 (02/18/2016)
+
+## Features
+
+ - Image Widget: added a new Widget for displaying images.
+
+ - YouTube Widget: added a new Widget for displaying YouTube videos.
+
+ - Data Source Broadcasting: rewrote all Data Sources and Widgets to communicate using global events.  This resolves memory leaks and performance degredation due to unremoved callbacks.
+
+ - Improved logging, and added a configurable property to enable debug logging (globally)
+
+## Bug Fixes
+
+ - Removed unique constraint on email field for Users
+
+## Breaking Changes
+
+ - The Data Source api method 'getData()' has been deprecated.  Any custom Widgets should be rewritten to follow the new event-based messaging pattern.  Any custom Data Sources which use the Data Source Factory (recommended) will automatically use the new pattern.
+
 # 1.24.0 (02/04/2016)
 
 ## Features

README.md

@@ -34,7 +34,7 @@ Dashboards are defined declaratively as a JSON document, which contains all the
 
 * Declarative definition of Dashboards, requiring no HTML or JavaScript (although it's optionally available)
 
-* Included Widgets: chart, table, number, html, javascript, iframe, stoplight, treemap
+* Included Widgets: annotationChart, chart, table, number, html, javascript, iframe, image, stoplight, treemap, youtube
 
 * Included Data Sources: JSON, Graphite, Splunk, JavaScript
 

cyclotron-site/app/partials/help/about.jade

@@ -58,9 +58,7 @@ p.
     of customization with some coding.  Cyclotron works best with minimally-interactive dashboards, as it lacks more robust 
     interaction features like dependent widgets and triggers.
 p.
-    Cyclotron has no data backend and doesn't store any Dashboard data.  Through Crunch, Cyclotron can pull data from databases, web services, 
-    file shares, Hadoop/Hive, etc.  Crunch can do light processing and transformations, but is not a replacement for
-    a scheduled ETL process.  In this regard, Cyclotron is ideal as a front-end for an existing database or web service.
+    Cyclotron has no data backend and doesn't store any Dashboard data. In this regard, Cyclotron is ideal as a front-end for an existing database or web service.
 p.
     Finally, Cyclotron has automatic page rotation and data-refreshing features, making it well-suited to hosting status boards and monitoring dashboards.  It is less suitable for generating 
     reports (although PDF export is available).

cyclotron-site/app/partials/help/dataSources.jade

@@ -2,12 +2,10 @@ h3 Data Sources
 
 p.
     Cyclotron provides several Data Source Types, each of which connects to an external service to 
-    pull in data for the Dashboard.  Most Data Sources and Widgets consume a common row/column interface, so Widgets and 
-    Data Sources are interchangeable.  Each Data Source handles converting data into this format automatically.
+    pull in data for the Dashboard. Data Sources and Widgets consume a common row/column interface, so Widgets and Data Sources are interchangeable. Each Data Source handles converting data into this format automatically.
 
 p.
-    Here is an example of the tabular data format, consisting of an array of rows.
-    Each row is a JavaScript object, where the keys represent columns and the values represent the value of each column.
+    Data Sources use a simple tabular data format, consisting of an array of rows. Each row is a JavaScript object, where the keys represent columns and the values represent the value of each column.  Here's an example:
 
 pre.code.
     [
@@ -19,11 +17,9 @@ pre.code.
     ]
 
 p.
-    The easiest way to verify that a Data Source is working is to use the Table Widget.  By default, the Table 
-    Widget will display all columns and rows, so it can be used to quickly view and verify the data available 
-    from a Data Source. Be aware that the Table Widget will automatically camel-case the column headers, 
-    but the correct capitalization must be used elsewhere to reference the columns.
-
+    Cyclotron is case-sensitive, which is especially significant when working with Data Sources.  When referencing column names in the Data Source, the correct capitalization must be used to match the upstream source.  Cyclotron itself does not modify the original capitalization of columns.
+p.
+    The easiest way to verify that a Data Source is working is to use the Table Widget.  By default, the Table Widget will display all columns and rows, so it can be used to quickly view and verify the data available from a Data Source. Be aware that the Table Widget will automatically camel-case the column headers, but the correct capitalization must be used elsewhere to reference the columns.
 
 h4 Common Properties
 

cyclotron-site/app/partials/help/encryptedStrings.jade

@@ -6,19 +6,19 @@ p.
 p
     | This feature is available in Data Sources that can be proxied through the Cyclotron Service, and require the
     em  proxy
-    | property to be set.  This includes the Crunch Data Source, JSON Data Source, and Graphite Data Source.
+    | property to be set.  This includes the JSON Data Source, Graphite Data Source, and Splunk Data Source.
 
 h3 How It Works
 
 ol
     li The Cyclotron Dashboard Editor encrypts the plaintext (before saving!), and wraps the encrypted text in \!{} to indicate that text is encrypted.
     li The encrypted text is saved directly in the Dashboard, and the unencrypted text is not saved at all.
-    li When viewing the Dashboard, the user's browser downloads the Dashboard definition, including the Data Sources and the Crunch query containing the encrypted password.
-    li The Crunch query is sent to the Proxy Server, which parses the query for sections of encrypted text.  Each one is decrypted using the same key.  
-    li The unencrypted Crunch query is sent from the Proxy Server to the Crunch service, which executes the query and returns the results.
-    li The Proxy Server returns the results to the browser.
+    li When viewing the Dashboard, the user's browser downloads the Dashboard definition, including the Data Sources and properties containing the encrypted password.
+    li An encrypted query is sent to the Proxy Server, which parses the request for sections of encrypted text.  Each one is decrypted using the same key.  
+    li The unencrypted reuqest is then executed from the Cyclotron service and the results returned to the proxy server.
+    li The Proxy Server returns the results to the browser, without leaking the unencrypted data.
 
-p This example assumes a Crunch query, but it applies similarly to other Data Sources with different encrypted properties.  Any property of the Data Source that is sent to the proxy server can be encrypted, as they are all handled generically.  The JSON Data Source supports encrypting the URL, Query Parameters, and Options.  The Graphite Data Source supports encrypting the URL, Targets, and From/Until.
+p This example applies similarly to any Data Sources with different encrypted properties.  Any property of the Data Source that is sent to the proxy server can be encrypted, as they are all handled generically.  The JSON Data Source supports encrypting the URL, Query Parameters, and Options.  The Graphite Data Source supports encrypting the URL, Targets, and From/Until.
 
 p All Cyclotron servers share the same encryption/decryption key, so any server can be used a proxy for any Dashboard.
 

cyclotron-site/app/scripts/common/services/services.analytics.coffee

@@ -14,7 +14,7 @@
 # language governing permissions and limitations under the License. 
 ###
 
-cyclotronServices.factory 'analyticsService', ($http, $q, $localForage, $location, userService, configService) ->
+cyclotronServices.factory 'analyticsService', ($http, $q, $localForage, $location, configService, logService, userService) ->
 
     # Helper for API methods that take optional dashboardId/startDate/endDate
     analyticsHelper = (name, endpoint, dashboardId, startDate, endDate) ->
@@ -152,6 +152,7 @@ cyclotronServices.factory 'analyticsService', ($http, $q, $localForage, $locatio
                 if userService.cachedUserId?
                     req.user = userService.cachedUserId
 
+            logService.debug 'Page View Analytics:', req
             $http.post(configService.restServiceUrl + '/analytics/pageviews?newVisit=' + newVisit + '&' + 'exporting=' + exports.isExporting, req)
 
     # Record the execution of a Data Source
@@ -171,6 +172,8 @@ cyclotronServices.factory 'analyticsService', ($http, $q, $localForage, $locatio
             duration: duration
             details: details
 
+        logService.debug 'Data Source Analytics:', req
+
         $http.post(configService.restServiceUrl + '/analytics/datasources', req)
 
     # Generic schema for recording events
@@ -192,6 +195,7 @@ cyclotronServices.factory 'analyticsService', ($http, $q, $localForage, $locatio
                 if userService.cachedUserId?
                     req.user = userService.cachedUserId
 
+            logService.debug 'Event Analytics:', req
             $http.post(configService.restServiceUrl + '/analytics/events', req)
 
     return exports