gohrec

README

GoHRec :: HTTP Request Recorder written in Golang

GoHRec logs HTTP requests it receive as JSON files, with all their details (including headers and body) and is able to redo these saved requests.

• Docker Hub: https://hub.docker.com/r/frxyt/gohrec
• GitHub: https://github.com/frxyt/gohrec

Docker Hub Image

frxyt/gohrec

Build

• Binary:
  • Linux: go build -o gohrec .
  • Windows: go build -o gohrec.exe .
• Docker: docker build -t frxyt/gohrec:latest .

Usage

• docker run --rm -p 8080:8080 -v $(pwd):/gohrec/log frxyt/gohrec:latest
• docker-compose up
• gohrec --listen=:8080 --only-path=^/api --except-path=/admin

Options

gohrec record: record requests

• --date-format <format>: Go format of the date used in record filenames, required subfolders are created automatically (default: 2006-01-02/15-04-05_).
• --echo: Echo logged request on calls.
• --except-path <regexp>: If set, record requests that don't match the specified URL path pattern.
• --index: Build an index of hashes and their clear text representation.
• --listen <interface:port>: Interface and port to listen (default: :8080).
• --max-body-size <bytes>: Maximum size of body in bytes that will be recorded, -1 to disallow limit (default: -1).
• --only-path <regexp>: If set, record only requests that match the specified URL path pattern.
• --pprof: Enable pprof endpoints /debug/pprof/*.
• --proxy: Enable proxy mode.
• --redact-body <regexp>[/<replacement>]: If set, matching parts of the specified pattern in request body will be redacted.
• --redact-headers <regexp>>[/<replacement>]: If set, matching parts of the specified pattern in request headers will be redacted.
• --target-url <url>: Target URL used when proxy mode is enabled.
• --verbose: Log processed request status.

gohrec redo: redo a saved request

• --host: If set, change the host of the request to the one specified here.
• --request: JSON file of the request to redo.
• --timeout: Timeout of the request to redo (default: 60s).
• --url: If set, change the URL of the request to the one specified here.

License

This project and images are published under the MIT License.

MIT License

Copyright (c) 2020 FEROX YT EIRL, www.ferox.yt <devops@ferox.yt>
Copyright (c) 2020 Jérémy WALTHER <jeremy.walther@golflima.net>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.