POC: Auto generation of troubleshooting guide #1223
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
doodlesbykumbi
force-pushed
the
troubleshooting
branch
from
ef7fa7a
to
35afd41
Compare
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
| } | ||
|
|
||
| // proxyGet is a convenience method that makes an HTTP GET request using a proxy | ||
| func proxyGet(endpoint, proxy string) (*http.Response, error) { |
There was a problem hiding this comment.
Identical blocks of code found in 2 locations. Consider refactoring.
| @@ -0,0 +1,228 @@ | |||
| package troubleshooting | |||
There was a problem hiding this comment.
Your code does not pass gofmt in 6 places. Go fmt your code!
| @@ -0,0 +1,128 @@ | |||
| package troubleshooting | |||
There was a problem hiding this comment.
Your code does not pass gofmt in 2 places. Go fmt your code!
| * TCP_NODELAY set | ||
| * Connected to 127.0.0.1 (127.0.0.1) port 62160 (#0) | ||
| * Establish HTTP proxy tunnel to httpbin.org:443 | ||
| > CONNECT httpbin.org:443 HTTP/1.1 |
| * Connected to 127.0.0.1 (127.0.0.1) port 62160 (#0) | ||
| * Establish HTTP proxy tunnel to httpbin.org:443 | ||
| > CONNECT httpbin.org:443 HTTP/1.1 | ||
| > Host: httpbin.org:443 |
|
Code Climate has analyzed commit 35afd41 and detected 63 issues on this pull request. Here's the issue category breakdown:
The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 48.4% (0.0% change). View more on Code Climate. |
Creating the proxy service in memory makes it very easy to have a troubleshooting generation as code approach. This commit provides an example using the HTTP connector. A similar approac h would work for other connectors. It manages to capture client output and relevant Secretless logs all in one fell swoop.
doodlesbykumbi
force-pushed
the
troubleshooting
branch
from
35afd41
to
8cbd67e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creating the proxy service in memory makes it very easy to have a troubleshooting generation as code approach. This commit provides an example using the HTTP connector. A similar approach would work for other connectors. It manages to capture client output and relevant Secretless logs all in one fell swoop.
You'll note that
http_proxy_service.goin the files changes is almost identical to a file you'll find in the MSSQL integration tests PR. This is because the logic to start proxy services is more or less the same and really should exist within some module in Secretless to make doing this easier. Especially if we have any intention of using this approach as a test harness.