RiotGames/OpenTSDBPluginLib — Issue #1: Better getting started docs
Author: scurvy
Created: 2012-01-18 20:48:30+00:00
State: open

First off, thanks for writing this plugin! I'm working my way through setting up Flume->OpenTSDB now. I've got the basics down, but I'm having some trouble because your connector needs more robust documentation.

For instance, you write:
exec config node1 'multitail("/proc/vmstat", "/proc/meminfo")' 'regexAll("(\\w+)\\W+(\\w+)", "metric","value")openTSDB("%{metric}", "%{value}", "", "%s","%{host}")'

To someone who doesn't have much Flume experience, nor much java background, that line can be tough to decipher. Also, your openTSDB plugin has no actual documentation on what the arguments are. You could quite easily list them here rather than having users add a bad configuration entry just to see the output from the Flume master.

Even then, how do multiple tags work? How do simple tags even work? In yours you put "%{host}"...does the plugin automatically add "host=%{host}" when putting it on the wire or should we add that? Just some basic explanation of your example and the basic arguments would be great. Thanks!