Canary

 

For customers of existing commercial apps

If you’re a customer of one of our existing commercial apps for Splunk, here’s what you need to know.

In Splunk 8 and higher, you will have to install the Canary app as well as the Sideview Utils app.
Put another way, our existing commercial apps will not run at all on Splunk 8 until the Canary is also installed on the Search Head or SHC.
Canary is essentially a replacement for, and an upgrade over, the old Sideview Utils app. Technically the only reason Sideview Utils needs to remain at all on 8.X is so that some of the automatic redirects from legacy Advanced XML URLs to the equivalent Canary URLs work properly.

Should I upgrade the apps first or Splunk first
ALWAYS upgrade all of your Sideview apps to latest BEFORE upgrading Splunk Enterprise itself. Contact us if you have questions.

You can download and install Canary today
It is easy to get Canary installed because it is also on Splunkbase — from Splunk’s in-product Apps browser (go to Apps > Find more apps > search for ‘canary’).

Don’t I have to get 8.0 in order to run Canary?
No – Canary runs fine on both 7.X and 8.X. In 7.X, in the Cisco CDR app specifically, if you have Canary installed you will get a little “switch to canary UI” link in the top right on all pages. This way you can test out the Canary UI before actually upgrading to 8.X.

If your Splunk deployment is unable to reach Splunkbase you can also download it as a tar.gz file from Splunkbase or directly from this website.

The functionality of your app will be unchanged, however the look and feel of the UI will be noticeably different.
We’re eager to hear any and all feedback.
We apologize in advance for any defects you encounter and we will try and fix them as quickly as possible.
We hope that the change is positive. For one thing pages in the Canary UI render a great deal faster. Certainly faster than they did before in the old Splunk UI, but also faster than Splunk’s “Simple xml” dashboards. You may even get a little spoiled by this.

You don’t need any new special license.
As a part of your existing license agreement for the commercial app, Sideview is effectively granting you a license to use the Canary app in conjunction with that commercial app.
The app will be fully supported to run in the Canary UI on Splunk 8 and up, and will also remain supported on 7.X in the old Splunk UI.
If (or when) you find defects on either side, please do report them. We are shipping maintenance releases about once a month and in the event that you do find a defect in the product we can typically fix it in the next release.

Canary runs fine in both Python2 and Python3
Canary’s pieces are already all tested and supported in Python3 so Canary will run just fine on Splunk 8. If you encounter any problems of course let us know. If you find that Splunk’s “Splunk Platform Upgrade Readiness App” is flagging our apps, just ignore it. The app as of this writing has a bug where it does not notice that we have certified that the apps run on python3 already.

What if some of our team members figured out how to use the Sideview Editor and started making their own interactive Sideview XML views?
This is quite unlikely! However if this is a possibility then you should also read this other FAQ for Sideview XML view developers.