Haystack Debug

Owned by Kimberly Cruz (Unlicensed)
Last updated: Sept 12, 2022 by Ricky Villa
3 min read

The haystack debug tool is great for debugging and seeing what the request and responses are. This is crucial information for the developers to know what is happening. Do this if you get a different error than what is provided in the Haystack Troubleshooting doc and weren't able to resolve your connection issue. Then you can post that in a forum in Project Haystack (without the request if you like) to see if a developer or someone in the community might know of the issue. You can send it to us at support@j2inn.com in case we might be able to help resolve the issue.

User credentials are needed for this and so this will be visible to anyone viewing this. It would be best if you create a new super user with simple credentials that you wouldn't mind displaying just to get the debug info. Or change your password and then back to the original one.

Follow the steps below for Windows. This should be similar to Linux and Mac if you are familiar with them. The user just needs to get to the bin folder and execute the command.

  1. Open the command line on the machine hosting FIN and that can hit the Niagara station

  2. In the command line, navigate to the bin folder of FIN directory. Should be something like this: C:\Program Files (x86)\FIN Framework\FIN Framework <version number>\bin

  3. Then run this command with the Niagara station uri fan haystack::Client <url> <user> <pass> which should look something like this: fan haystack::Client http://10.10.10.107/haystack fin fin

  4. What it returns is the debug info. You should then be able to "mark" it and copy-paste it on a notepad/email.

  5. To mark it, you can right-click and find the option to mark. Or right-click on header of the command-line window to find Edit > Mark. Then select the text.

  6. To copy the text, do Ctrl + C and paste it on a notepad or email.

  7. Below is my example of what it returns along with the request (the command we executed):

    <C:\Program Files (x86)\FIN Framework\FIN Framework 5.0.3.2752\bin> fan haystack::Client http://10.10.10.107/haystack fin fin [13:08:23 07-Feb-18] [debug] [haystackClient] > [0] GET http://10.10.10.107/haystack/about Authorization: hello username=Zmlu Accept-Encoding: gzip User-Agent: SkyArc/2.1.15 [13:08:23 07-Feb-18] [debug] [haystackClient] < [0] 500 Internal Server Error date: Wed, 07 Feb 2018 21:08:23 GMT content-length: 893set-cookie: niagara_session=s26aed0f964d482601feaa776fe286361c40201a1737923ac1d; path=/; HttpOnly expires: Thu, 01 Jan 1970 00:00:00 GMT x-frame-options: sameorigin content-type: text/html; charset=UTF-8 cache-control: private, must-revalidate <html> <head> <meta name='viewport' content='width=device-width initial-scale=1.0 maximum-scale=1.0 target-densityDpi=medium-dpi' /> </head> <body> <h1>500: Internal Server Error</h1> <p>The above error occurred while processing your request.</p> <button style='font-size: 150%; font-weight: bold;' onclick='history.back();'>Back</button> </body> </html> sys::IOErr: HTTP error code: 500 haystack::AuthClientContext.open (AuthClientContext.fan:92) haystack::Client.openAuth (Client.fan:61) haystack::Client.main (Client.fan:330) java.lang.reflect.Method.invoke (Unknown) fan.sys.Method.invoke (Method.java:559) fan.sys.Method$MethodFunc.callList (Method.java:198) fan.sys.Method.callList (Method.java:138) fanx.tools.Fan.callMain (Fan.java:183) fanx.tools.Fan.executeType (Fan.java:147) fanx.tools.Fan.execute (Fan.java:41) fanx.tools.Fan.run (Fan.java:308) fanx.tools.Fan.main (Fan.java:346)