Add information on debugging #1045
Conversation
@mhilbush FYI if you have any comments Signed-off-by: Chris Jackson <chris@cd-jackson.com>
|
This pull request has been mentioned on openHAB Community. There might be relevant details there: https://community.openhab.org/t/z-wave-things-lose-their-lifeline-association-group/44244/87 |
|
I'll take a look in a couple hours. |
|
Thanks.
… On 28 Oct 2018, at 13:44, Mark Hilbush ***@***.***> wrote:
I'll take a look in a couple hours.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub <#1045 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA_kQ8EuSvyBJwdTLSS9r8x7GolWIYjgks5upbTHgaJpZM4X99oK>.
|
README.md
Outdated
|
|
||
| Z-Wave is a complex protocol, and there are many manufacturers producing thousands of devices that are expected to interact seemlessly. In the most part, this does work as hoped, however there are always devices with bugs, or features that don't work as expected. When this happens, the debug logging from the binding is the key to understanding, and ultimately solving, any issues. | ||
|
|
||
| To enable debug logging, log on to the console and enter the following command -: |
There was a problem hiding this comment.
I'm not sure of the policy for embedding links in the documentation. If that's allowed/encouraged, you could include a link here (https://www.openhab.org/docs/administration/console.html).
| ``` | ||
| log:set debug org.openhab.binding.zwave | ||
| ``` | ||
|
|
There was a problem hiding this comment.
To disable debug logging, enter the following command -:
log:set INFO org.openhab.binding.zwave
There was a problem hiding this comment.
I'm 99.9% sure it doesn't matter as I don't both using upper case and I've not noticed an issue. However I've changed it as it highlights the level better anyway...
README.md
Outdated
| To enable debug logging, log on to the console and enter the following command -: | ||
|
|
||
| ``` | ||
| log:set debug org.openhab.binding.zwave |
There was a problem hiding this comment.
Is lower case debug allowed? I normally use uppercase (DEBUG).
| ## When things don't go as planned | ||
|
|
||
| Z-Wave is a complex protocol, and there are many manufacturers producing thousands of devices that are expected to interact seemlessly. In the most part, this does work as hoped, however there are always devices with bugs, or features that don't work as expected. When this happens, the debug logging from the binding is the key to understanding, and ultimately solving, any issues. | ||
|
|
There was a problem hiding this comment.
When providing a debug log, provide the full log; don't filter anything out. Provide the log with plenty of context before and after the event you're trying to troubleshoot. Sometimes the root cause of the problem happens considerably beforehand. If the log file is too big to include in your forum post, place it on a file-sharing service, and include a link to the file in your post.
README.md
Outdated
| log4j2.appender.Zwave.policies.size.type = SizeBasedTriggeringPolicy | ||
| log4j2.appender.Zwave.policies.size.size = 10MB | ||
| log4j2.appender.Zwave.strategy.type = DefaultRolloverStrategy | ||
| log4j2.appender.Zwave.strategy.max = 20 |
There was a problem hiding this comment.
Let's make this 10. I set it to 20 in this case because it was very unclear when the problem actually occurred.
|
Thanks Mark. I've taken into account your comments - much appreciated. |
|
Sure thing. 👍 We now can provide a reference to this part of the doc, which hopefully will reduce some of the back and forth trying to get a good debug log. |
| log4j2.appender.Zwave.name = ZWAVE | ||
| log4j2.appender.Zwave.type = RollingRandomAccessFile | ||
| log4j2.appender.Zwave.fileName = /opt/openhab2/userdata/logs/zwave.log | ||
| log4j2.appender.Zwave.filePattern = /opt/openhab2/userdata/logs/zwave.log.%i |
There was a problem hiding this comment.
These should've been:
log4j2.appender.Zwave.fileName = ${openhab.logdir}/zwave.log
log4j2.appender.Zwave.filePattern = ${openhab.logdir}/zwave.log.%i
|
Updated - thanks.
|
@mhilbush FYI if you have any comments
Signed-off-by: Chris Jackson chris@cd-jackson.com