Skip to content
farcloserPublic

About

Core Go library shared by farcloser projects: zerolog logging, Sentry reporting, OpenTelemetry, TLS and network helpers, exec, human-readable units, safe filesystem primitives

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

Farcloser core go library

Provides basics to be used by all our go projects, specifically:

  • logging (based on zerolog)
  • reporter (based on Sentry)
  • telemetry (based on otel)
  • network (to ease manipulation of global network settings, specifically related to TLS)
  • exec (to ease shelling out)
  • human-readable units and duration
  • filesystem safe operations primitives (locking, atomic writes)
  • etc

Dev

Requirements

Review or call directly ./hack/dev-setup-linux.sh or ./hack/dev-setup-macos.sh

Then, make install-dev-tools

Makefile

make fix
make lint
make test

Local documentation

go install golang.org/x/pkgsite/cmd/pkgsite@latest
pkgsite
open http://localhost:8080/go.farcloser.world/core

Charter

  1. This should contain solely stuff that is generic, likely to be used by any reasonable go project (eg: logging, telemetry, etc.). Refrain from adding here anything that is specific to a given project, or ecosystem.

  2. Hide implementation away. Specifically, make sure the underlying dependencies do not leak into your API.

TODO

About

Core Go library shared by farcloser projects: zerolog logging, Sentry reporting, OpenTelemetry, TLS and network helpers, exec, human-readable units, safe filesystem primitives

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages