icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Canary
SHA256 checksum (canary_107.tgz) 8e4b07f78d5494a383f6a3aeeea9004e83c54f0aa23af57bed89904a4c820431 SHA256 checksum (canary_106.tgz) 994a59e6f0b3aeabfedca0a8a627a35cfd68b139c8c0a4001ce5b90cdf1776ac SHA256 checksum (canary_105.tgz) 3086e2c7709f92d2246be357f5bf2195e0d11bb3f3e21bb64ecbd7934b062939 SHA256 checksum (canary_104.tgz) 8bd80cda536c83b5429122e9b96851aadb43499b4a01abccf0a98e9de5a22051 SHA256 checksum (canary_103.tgz) 6e186b1c5d710aeb514583546183b1c666d82bdef921fbe7a9d9102e96ffc81b SHA256 checksum (canary_102.tgz) ae0a243fcbf2017421cf369adb58169db451b39ff60f1b49d00d7216232033d6 SHA256 checksum (canary_101.tgz) 4e20563ef83999038950e2c9414019efcd1a3aea39f578c7aa8ca2c94d03b299 SHA256 checksum (canary_10.tgz) e202e3cc669d035e755308305578e4b6349efaff40f62391b1b2deb8f0e738bc SHA256 checksum (canary_09.tgz) 03c481fc15d498f3c7fb81b9cbafd6304442427c3bc5260338772af0e52d5c7d SHA256 checksum (canary_081.tgz) c4444e58f5c3a6e3d83acf08ea3bfd4fdf4c9ef809b24c88f7196bc8a2aa0f3e SHA256 checksum (canary_08.tgz) 3d368d9bf67fce34a2915974a4d2d8fe815ed7fade23912af846bbc939fd1d1a SHA256 checksum (canary_072.tgz) 5407508cf08c398de33a0b891a14850c86d7b37026734035136b3619150ad140
To install your download
For instructions specific to your download, click the Details tab after closing this window.
To install apps and add-ons from within Splunk Enterprise
  1. Log into Splunk Enterprise.
  2. On the Apps menu, click Manage Apps.
  3. Click Install app from file.
  4. In the Upload app window, click Choose File.
  5. Locate the .tar.gz file you just downloaded, and then click Open or Choose.
  6. Click Upload.
  7. Click Restart Splunk, and then confirm that you want to restart.
To install apps and add-ons directly into Splunk Enterprise
  1. Put the downloaded file in the $SPLUNK_HOME/etc/apps directory.
  2. Untar and ungzip your app or add-on, using a tool like tar -xvf (on *nix) or WinZip (on Windows).
  3. Restart Splunk.
After you install a Splunk app, you will find it on Splunk Home. If you have questions or need more information, see Manage app and add-on objects.

Flag As Inappropriate


Admins: Please read about Splunk Enterprise 8.0 and the Python 2.7 end-of-life changes and impact on apps and upgradeshere.
Canary is an app that is essentially an alternate front end to Splunk. It implements its own extensible user interface and dashboarding system that other apps can use.
Since it is backwards compatible to a subset of the "Sideview XML" views that you might have created with Sideview Utils, it offers a path for existing Sideview Utils content to potentially continue running even in Splunk 8 after the "Advanced XML" systems are removed.
It is a descendant of Sideview Utils but whereas Sideview Utils ran on top of Splunk’s “Advanced XML” systems, Canary does not.
For a great deal more information about Canary, see our website ( https://sideviewapps.com/apps/canary/ )

Release Notes

Version 1.0.7
Jan. 16, 2020

- Fixed a problem where clicks to Simple XML dashboards, or HTML dashboards like the "search" view wouldn't redirect properly and the user would end up on the wrong URL with a confusing "response has no payload" error.
- Improvement in error handling to propagate the actual error string out to the user
- Fixed a bug that only seems to occur on Chrome whereby clicks on the "export" icon would fail and land you on a page saying Unknown sid".

Version 1.0.6
Jan. 10, 2020

Fixed a regression in TimePicker introduced only in 1.0.5 (released yesterday), where pages would hang if a TimePicker received a push from upstream modules while it was still waiting for the global page preferences to load.

Version 1.0.5
Jan. 9, 2020

For full release notes see the release notes page on our site - https://sideviewapps.com/apps/canary/release-notes/

(Unfortunately Splunkbase still limits the release notes field at only 1000 characters, and the release notes for this release are a bit longer. )

Version 1.0.4
Dec. 12, 2019

For full release notes see the release notes page on our site - https://sideviewapps.com/apps/canary/release-notes/

(Unfortunately Splunkbase still limits the release notes field at only 1000 characters, and the release notes for this release are considerably longer. )

Version 1.0.3
Nov. 23, 2019

-- Canary UI now supports the use of the "root_endpoint" key in web.conf. This key is commonly used in SSO configurations as well as in advanced configurations where more than one splunk instance or more broadly when more than one web application needs to be accessible on a single host and port.
-- Fixed a bug in the Chart module where it could throw an exception particularly on non-previewable jobs and fail to render.
-- Fixed a python3 syntax error in the "checkxml" command that would make the command fail if it encountered a broad range of view misconfigurations.

Version 1.0.2
Nov. 12, 2019

-- Resolved a major issue where if users were accessing splunkWeb through a local port that differed from the httpport configured in web.conf (as is common when proxies or ssh tunnels are involved), that many requests would fail CSRF validation and receive a 401 error when attempting to dispatch searches or POST to any endpoint.
-- customBehavior code (in custom apps) that tries to create an intance of the legacy Splunk.Search class will now end up with an instance of Canary's SplunkSearch class instead. For most simple common tasks, this will give equivalent functionality.

Version 1.0.1
Nov. 5, 2019

> Fixed a bug where the page title had "None" where the app's name should be.
> Fixed a bug in the Fields module where if you reordered a field in the selected field list, it would remove the field entirely.
> Fixed a class of bugs that would happen in some complex configurations, where modules would end up with stale values downstream.
> Fixed a bug where the Pulldown module was accidentally pushing downstream twice, causing an extra cancel and redispatch and other confusing behavior and slowness.
> Fixed a bug where the Report module, when given input to create a timechart and when given an explicit bins argument for the primary axis, it would ignore the bins argument.
> Fixed a bug in the Pulldown module where customBehaviors were unable to explicitly select the emptystring option within the control.
> Added postProcess support to the Fields module.
> Resolved a bug in the Fields module where if you had multiple instances on a page, the filter-as-you-type search field would only work for one of them.

Version 1.0
Oct. 22, 2019

> logged in user name is now the users full name instead of the username
> Significant improvements to page rendering speed
> SearchControls module now has an 'export' button again
> Fixed a bug where any attempts to save a job would fail and the job would be paused instead
> Fixed a bug where the search command to check views for canary compatibility would trip up on any views using the new patterns.

Version 0.9
Oct. 16, 2019

- There is now an implementation of "ui patterns". Chunks of view config can be saved in appserver/patterns and then loaded into views by referencing just the pattern name. This allows view developers to avoid repetition and to keep their views compact and easier to maintain.
- Fixed a bug in the Chart module where the number of points on the primary axis (x-axis) was being cut off at 100.
- Fixed a directory traversal bug in the HTML module's "src" param.

Version 0.8.1
Oct. 9, 2019

Fixed bugs where some modules might fail to remember selection preferences, due to ui-prefs.conf.spec having been mistakenly omitted from README subdirectory
Added some logic to enforce a minimum required version number for specific apps like Cisco CDR, so users dont accidentally do compatibility testing with versions that are simply too old.


Version 0.8
Oct. 7, 2019

Splunkbase still truncates release notes to 1000 characters unfortunately which isn't really enough.

To read the full release notes for 0.8 see - http://sideviewapps.com/apps/canary/release-notes/

Version 0.7.2
Sept. 23, 2019

Version 0.7.2 (September 19th, 2019)

Public Beta
Migration work around the optional 'customStylesheet' and 'customJavascript' params in the SideviewUtils module itself. Since this module doesn't exist in Canary, and file or files specified here are now shifted over to customJS and customCSS fields at the view level

Version 0.7.1 (September 14th, 2019)

Many cosmetic fixes
AppNav module tries to make app developers life easier by at least logging an error if the nav explicitly specifies a view that the current user cannot see.
some bugs fixed in the code that converted the view config to the yaml format, that had been erroneously putting some redundant keys back in.
Chart module has new improved chart colors for all cases where there are fewer than 7 series
Fixed a bug in the Fields module where the available fields list would not render if you opened the layer before they were available.
Fields module and TimePicker module now save and load the user's preferences from/to ui-prefs.conf
Fields module now has a 'reset to default' link that can reset the user's selected fields.
Fixed a bug where multiple modules that used menu-ing systems, like AppNav, TopNav and TimePicker, could have their menus open at the same time.
Fixed a small bug in the Table module where trying to select the name of a column header would sort by that column.
TimePicker module's "Custom" mode now works with URLLoader when latter is in 'keepURLUpdated' mode.
Fixing the Chart module's rendering when each timechart bucket is just one second or a few seconds.

Version 0.7 (September 9th, 2019)

Changing default sort order in the Table module to be descending
Improvement to the shared menu code so the last-opened submenu doesn't stick open while you're mousing around.
Ported over the hideOnEmpty param for CheckboxPulldown which had been added to Sideview Utils in the past year.
Improved tooltip positioning and design in the Chart module when there is a split-by field.
Fields module now saves and loads the users current selected fields to/from ui-prefs.conf
Improvements to how things work as the user clicks around from Simple XML views to HTML dashboard views, to canary views, in the app nav bar
Fixed some general module loading logic that was preventing the Link and Button module's "allowAutoSubmit" params from working.
Quite a lot of small compatibility fixes for when an admin has set Splunk Enterprise 8.0 to run all apps in python3.
Fixed a bug in TimePicker where it would erroneously push changes downstream when you opened the "Custom" modal popup.
Fixed a bug in some advanced Multiplexer cases.
Fixed file encoding issues with a couple third party libraries that were causing breakage on Python3
Removed last usage of the Splunk Python SDK
Fixed various problems in the Sideview licensing endpoint when run in Python3.

Version 0.6.1 (August 28th, 2019)

TopNav module now has a link to the Admin section landing page.
if apps link to 'search' with a canary uri, the controller now redirects the browser to the standard splunk uri, retaining other params.
Deleting the "Messaging" module as it dates from extremely early on in Canary's timeline and the level of configurability that it aimed for now seems silly. All messaging rewritten to be handled by a single message area for now.
Fixed bugs in CheckboxPulldown and Multiplexer modules that were causing an extra cycle of job dispatch+cancel in some cases.
Fixed a bug in the AppNav module where clicks upon the actual arrow icons would fail to open the submenu.
Introduced a mechanism where any module can set a "hideChildrenOnload" param to True, and all downstream modules will load hidden when the page first loads.
Fixed a bug where modules in some hierarchies would end up with the incorrect layout panel
Fixed bugs in the Pager module around the two-pager configuration (with one above and one below).
Fixed a bug where job progress events were not firing on previewable jobs.
Chart module modified so on progress events it will update it's existing chart object instead of recreating it from scratch.
Search module now can accept $foo$ tokens in its "preview" param, allowing this to be set from form elements or other upstream logic
Chart module now, even if the job is not previewable, it will at least update with a little "Loading (12.34%)" text.
TimePicker module now gets the times.conf stanzas in correct order (sorted by the order key, numerically)
Fixed a bug in CheckboxPulldown where in some cases it would erroneously deselect all of its options on page load (instead of selecting all).

Version 0.6 (August 23rd, 2019)

First release (private alpha)
A list of release notes is not feasible since this is about 7 years of development.
Such a list would include thousands of stories added and defects resolved.


Subscribe Share

AppInspect Tooling

Splunk AppInspect evaluates Splunk apps against a set of Splunk-defined criteria to assess the validity and security of an app package and components.

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
© 2005-2020 Splunk Inc. All rights reserved.
Splunk®, Splunk>®, Listen to Your Data®, The Engine for Machine Data®, Hunk®, Splunk Cloud™, Splunk Light™, SPL™ and Splunk MINT™ are trademarks and registered trademarks of Splunk Inc. in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.