Include full example

[timdonovanuk]

Please include what you use as a trigger. Making the screenshot about 25px higher to show this would be great :)

[TheByteStuff]

Good idea. Traveling at the moment with limited access to internet. Will work on getting better example information.

[TheByteStuff]

Tim,

It isn't triggered per se. I have implemented a call to it which is defined in the Actions section of an Automation script.

Can you elaborate on what you are looking for or what problems you are having? The screen shot in the readme is from the Developer Tools/Services interface and includes all the data. The only thing missing is the "Call Service" button on the lower right.

-Brian

[boomam]

@TheByteStuff
I'll second @timdonovanuk 's note here -

The example showing just the action doesn't provide context on how to have this continually ship log events of a certain type to a remote syslog server.
 

The example right now only shows the 'end' of the configuration in HA, not the beginning.
Showing examples of triggers and/or conditions would be useful for the community - even if they are 'blank', as the methodology for adding automations otherwise does usually require the usage of those configs, so as a minimum I would suggest a section that says 'dont include anything for these' if that is the intended configuration.
 

As a real world example, I have it setup like the docs.
It does nothing. I can do a test run and I get a log, so the connection does work, but with nothing to trigger from the other logs, its effectively useless to function for shipping logs - unless the intention is to have events ship to a syslog server, and not actual HA logs, in which case, a description update (for the add-ins intended purpose) would be needed instead.

[TheByteStuff]

Thank you for for clarifying the concern. You are correct that my intent for this was to be used within an event to allow a message to be logged to a syslog server not to provide a mechanism for HA logs to be sent to a syslog server. Providing an option to push HA logging to a syslog server would be interesting but definitely was not the intended use for this.

I tweaked the Readme to clarify this point. I can create an example/screenshots of using this within context of an event if you think that would be helpful still. I opted to depict it from the developer console to show the various fields and for use as a quick test figuring folks would plug it into their events as desired.

[boomam]

Great feedback. I would personally suggest documentation down to a really pedantically level, but that's just me. :-p
 
Maybe a small bit of text outlining what 'can' go there as a real world example would help reduce any setup issues?