1229025 - Document treeherder-client logging/debugging

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

Today on IRC Rob was hitting 403s submitting data to stage using treeherder-client, however the server response (which would have made the issue easier to debug) wasn't output in the log, since the script being used hadn't set up a logger:
https://gist.github.com/rwood-moz/009b6fbde4ef901f22df

We should mention setting up logging briefly in the client docs to make this harder to forget, and also mention using the debug log level to expose the additional body/headers info that bug 1229022 will soon be making debug-only.

Comment 1

[GitHub Autolander Bot]

Attachment: [treeherder] mozilla:python-client-logging-docs > mozilla:master

Comment 2

[William Lachance (:wlach)]

Comment on attachment 8757923 [details] [review]
[treeherder] mozilla:python-client-logging-docs > mozilla:master

Great clarification.

Comment 3

[Treeherder GitHub Bugbot]

Commits pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/3ed821a01bfddb0738be966d847a8cc4dc5d9afe
Bug 1229025 - Docs: Fix the link to the Python Client section

https://github.com/mozilla/treeherder/commit/d5680e9796ec6120f4ce99f5d7183ced3edcb95f
Bug 1229025 - Docs: Capitalisation fixes

https://github.com/mozilla/treeherder/commit/c43ec94f0398d5ca6e75f213030946249b6f6827
Bug 1229025 - Docs: Add logging setup steps for the Python Client

Since several people have not had logging set up when trying to debug
issues using the client/API, so instead of a helpful error message (eg
reminding them to sync their clock for Hawk auth), they get:
`No handlers could be found for logger "thclient.client"`