Easy to use, extendable and superfast logging package for Go
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
go-logger requires a supported release of Go.
go get -u github.com/mrz1836/go-loggerFor use with Log Entries (Rapid7), change the environment variables:
export LOG_ENTRIES_TOKEN=your-token-here(Optional) Set custom endpoint or port parameters
export LOG_ENTRIES_ENDPOINT=us.data.logs.insight.rapid7.com
export LOG_ENTRIES_PORT=514View the generated documentation
- Native logging package (extends log package)
- Native support for Log Entries (Rapid7) with queueing
- Test coverage on all custom methods
- Supports different Rapid7 endpoints & ports
Library Deployment
goreleaser for easy binary or library deployment to GitHub and can be installed via: brew install goreleaser.
The .goreleaser.yml file is used to configure goreleaser.
Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.
Makefile Commands
View all makefile commands
make helpList of all current commands:
all Runs multiple commands
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
run-examples Runs all the examples
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs vet, lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-short Runs vet, lint and tests (excludes integration tests)
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
All unit tests and examples run via GitHub Actions and uses Go version 1.17.x. View the configuration file.
Run all tests (including integration tests)
make testRun tests (excluding integration tests)
make test-shortRun the Go benchmarks:
make benchRead more about this Go project's code standards.
Basic implementation:
package main
import "github.com/mrz1836/go-logger"
func main() {
logger.Data(2, logger.DEBUG, "testing the go-logger package")
// Output: type="debug" file="example/example.go" method="main.main" line="12" message="testing the go-logger package"
} |
 |
|---|---|
| MrZ | kayleg |
View the contributing guidelines and please follow the code of conduct.
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀
