feature request: `config test` command should return more helpful logs
See original GitHub issueI’m not sure what options are available but this is related to a slack thread https://meltano.slack.com/archives/CMN8HELB0/p1670907167441139 where meltano config tap-google-analytics test
was failing and it was hard to figure out what was wrong.
In this case the view_id was expected to be a string but was being passed in as an integer. The error message just says Plugin configuration is invalid
with no other context. Eventually we ran the tap with invoke
and it showed log messages that explained the misconfiguration singer_sdk.exceptions.ConfigValidationError: Config validation failed: <number> is not of type 'string'
. I also got the same generic Plugin configuration is invalid
message when testing a purposefully wrong client secret.
Potentially Helpful Ideas:
- Try to re-log the exception. Maybe we can say exactly what part of the json schema didnt pass validation or if the tap is executed we can re-log the exception (although I know thats tricky).
- Add a log to the config/test error output about what it means. I.e. “Plugin configuration is invalid. This could be related to a schema violation or because the tap was unable to connect to the source system with provided configs.” 🤷
- Add a suggestion to try using
invoke
to see if the tap returns a helpful log about whats misconfigured - The hub tells users to run config/test. Maybe it should also have a note to try running invoke.
cc @menzenski
Issue Analytics
- State:
- Created 9 months ago
- Reactions:2
- Comments:5 (1 by maintainers)
Top GitHub Comments
Following from the roadmap outlined here:
I’ve logged the ‘first step’ here:
If that is built, then:
It’s perhaps worth noting that if the
--log-level=debug
parameter is passed (meltano --log-level=debug config tap-google-analytics test
), the same clear error message is written to the logs but it’s effectively buried in many other log messages.