topic Re: Custom modules not loading in Splunk Search

Custom modules not loading

joonradley — Thu, 26 Aug 2010 14:13:02 GMT

Hi,

I have created some custom modules, but receive warnings that the module cannot be found when opening the view containing the modules.

Originally the modules where created under the following directories:

$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/search/mod1.conf
$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/search/mod1.js
$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/prototype/mod2.conf
$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/prototype/mod2.js

The modules showed up under splunk.xxx.com:8000/modules and modules loaded correctly when the view was loaded.

I then moved the modules to the app directory:

$SPLUNK_HOME/etc/apps/myapp/appserver/modules/mod1.conf
$SPLUNK_HOME/etc/apps/myapp/appserver/modules/mod1.js
$SPLUNK_HOME/etc/apps/myapp/appserver/modules/mod2.conf
$SPLUNK_HOME/etc/apps/myapp/appserver/modules/mod2.js

The modules showed up under splunk.xxx.com:8000/modules with the new paths, but when loading the view containing them I get the error - Splunk encountered the following unknown module: "mod1" . The view may not load properly.

Next I moved the modules back to the share directory, but under a new sub directory:

$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/mymods/mod1.conf
$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/mymods/mod1.js
$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/mymods/mod2.conf
$SPLUNK_HOME/share/splunk/search_mrsparkle/modules/mymods/mod2.js

Again the modules showed up under splunk.xxx.com:8000/modules with the new paths, but when loading the view containing the modules I get the same error message as above.

When I moved the modules back to the original directories where they where developed all worked fine again.

Can any one tell me what I am doing wrong?

Regards

Joon

Re: Custom modules not loading

sideview — Fri, 27 Aug 2010 08:28:18 GMT

I have not been able to get custom modules working either, and im similarly baffled. sorry i cant help but im also interested. I know people have done it so maybe they can see what you/we are doing wrong.

Re: Custom modules not loading

zscgeek — Fri, 27 Aug 2010 10:25:06 GMT

I was able to get a custom mod working after much hair pulling however it was touch ago go every step of the way.

This is what I have for a file layout:

First Mod

./etc/apps/prophecy-premise/appserver/modules/VAppBar/VAppBar.conf
./etc/apps/prophecy-premise/appserver/modules/VAppBar/VAppBar.css
./etc/apps/prophecy-premise/appserver/modules/VAppBar/VAppBar.html
./etc/apps/prophecy-premise/appserver/modules/VAppBar/VAppBar.js

Second Mod

./etc/apps/prophecy-premise/appserver/modules/VTitleBar/VTitleBar.conf
./etc/apps/prophecy-premise/appserver/modules/VTitleBar/VTitleBar.css
./etc/apps/prophecy-premise/appserver/modules/VTitleBar/VTitleBar.html
./etc/apps/prophecy-premise/appserver/modules/VTitleBar/VTitleBar.js

I put each mod in it's own folder in order to get it to load. I am pretty sure this is critical for it to work.

Please note that the JS script is VERY VERY finicky. If there are any errors whatsoever in your code it will silently fail with the error you are seeing above.

My pain and suffering is documented on the answers page over at How to get rid of warning for custom modules?

Re: Custom modules not loading

sideview — Wed, 01 Sep 2010 13:20:37 GMT

fwiw I found the mistake I'd made that was preventing them from loading. In the .conf file I listed the classname as instead of Splunk.Module. . Once i fixed that they worked like a charm.

Re: Custom modules not loading

joonradley — Mon, 06 Sep 2010 15:37:09 GMT

Thank you for your responses.

I thought I would just give feedback on your suggestions.

@zscgeek: Your suggestion of placing each module in its won directory using the module name as the directory name did not work for me. I tried different capitulation. Neither did the module named directories work under the share/splunk/mr_sparkle/ modules direrctory.

@zscgeek: The javascript works 100% when the modules are placed under the normal directories.

@nick: In my case the class name is already Splunk.Module.<modulename>.

I will work try again to resolve this next month when we work on the second version of the app.

Re: Custom modules not loading

sideview — Thu, 06 Mar 2014 23:49:04 GMT

I know it has been years, but for the record another thing that can seriously cause confusion, is that if you have any other app installed that has a directory by that name inside appserver, and a partial set of files therein, or a modulename.conf file in it with a typo, Splunk is very bad about logging anything about the duplicate module and both versions of the module will just quietly die.