lint

Author: vodolaz095

Makefile

@@ -3,6 +3,11 @@ deps:
 	go mod verify
 	go mod tidy
 
+tools:
+	which go
+	which golint
+	which govulncheck
+
 # go install golang.org/x/lint/golint@latest
 lint:
 	gofmt -w=true -s=true -l=true ./

README.md

@@ -1,9 +1,46 @@
 pkg
 =====================================
-
 [![Go](https://github.com/vodolaz095/pkg/actions/workflows/go.yml/badge.svg)](https://github.com/vodolaz095/pkg/actions/workflows/go.yml)
 [![PkgGoDev](https://pkg.go.dev/badge/github.com/vodolaz095/pkg)](https://pkg.go.dev/github.com/vodolaz095/pkg?tab=doc)
 [![Go Report Card](https://goreportcard.com/badge/github.com/vodolaz095/pkg)](https://goreportcard.com/report/github.com/vodolaz095/pkg)
 
-
 Various functions copy-pasted between different projects.
+
+cryptorand
+=======================================
+Generate cryptographically secure random strings with alphabet provided
+
+date
+=======================================
+Date and time helpers - see [moments_test.go](date%2Fmoments_test.go)
+
+math
+=======================================
+Various generic mathematical functions copy-pasted between different projects.
+
+stopper
+=======================================
+Make global application context which can be terminated by signals
+
+tracing
+=======================================
+Opinionated way to configure OpenTelemetry with `jaegertracing/all-in-one` started like with docker compose like this
+
+```yaml
+
+version: "3.11"
+
+services:
+  jaeger:
+    container_name: jaeger
+    image: docker.io/jaegertracing/all-in-one:1.37
+    ports:
+      - "16686:16686/tcp" # webui is listening
+      - "14268:14268/tcp" # accepting spans in compact jaeger thrift format over http
+      - "6831:6831/udp" # accepting spans in compact jaeger thrift format over udp
+
+```
+
+zerologger
+=======================================
+Opinionated way to configure zerolog with sane defaults

cryptorand/rand.go

@@ -2,11 +2,19 @@ package cryptorand
 
 import "crypto/rand"
 
+// FullAlphabet defines one of possible alphabets used for generating random string
 const FullAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+
+// CaptchaAlphabet defines one of possible alphabets used for generating random string
 const CaptchaAlphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+
+// NumbersAlphabet defines one of possible alphabets used for generating random string
 const NumbersAlphabet = "0123456789"
+
+// CapitalLettersAlphabet defines one of possible alphabets used for generating random string
 const CapitalLettersAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 
+// GenerateRandomBytes generates cryptographically secure random bytes
 func GenerateRandomBytes(n int) ([]byte, error) {
 	b := make([]byte, n)
 	_, err := rand.Read(b)
@@ -16,6 +24,7 @@ func GenerateRandomBytes(n int) ([]byte, error) {
 	return b, nil
 }
 
+// GenerateRandomString generates cryptographically secure random string using alphabet provided
 func GenerateRandomString(alphabet string, n int) (string, error) {
 	bytes, err := GenerateRandomBytes(n)
 	if err != nil {

date/moments_test.go

@@ -13,5 +13,4 @@ func TestMoments(t *testing.T) {
 	t.Logf("EndOfWeek: %s", EndOfWeek(now).Format(time.Stamp))
 	t.Logf("BeginningOfMonth: %s", BeginningOfMonth(now).Format(time.Stamp))
 	t.Logf("EndOfMonth: %s", EndOfMonth(now).Format(time.Stamp))
-
 }

go.mod

@@ -9,6 +9,7 @@ require (
 	go.opentelemetry.io/otel v1.33.0
 	go.opentelemetry.io/otel/exporters/jaeger v1.17.0
 	go.opentelemetry.io/otel/sdk v1.33.0
+	go.opentelemetry.io/otel/trace v1.33.0
 )
 
 require (
@@ -21,7 +22,6 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/otel/metric v1.33.0 // indirect
-	go.opentelemetry.io/otel/trace v1.33.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

stopper/cancel.go

@@ -6,6 +6,7 @@ import (
 	"syscall"
 )
 
+// NewWithContext makes child context which is terminated when process receives stop signals
 func NewWithContext(parent context.Context) (ctx context.Context, cancel context.CancelFunc) {
 	return signal.NotifyContext(parent,
 		syscall.SIGHUP,
@@ -15,6 +16,7 @@ func NewWithContext(parent context.Context) (ctx context.Context, cancel context
 		syscall.SIGABRT)
 }
 
+// New makes context which is terminated when process receives stop signals
 func New() (ctx context.Context, cancel context.CancelFunc) {
 	return NewWithContext(context.Background())
 }

tracing/all.go

@@ -6,6 +6,7 @@ import (
 	"go.opentelemetry.io/otel/attribute"
 )
 
+// Config is universal config being used to tune tracing
 type Config struct {
 	// Protocol sets how we send spans to jaeger - over udp or over http
 	Protocol string `yaml:"protocol" validate:"required,oneof=udp http UDP HTTP"`
@@ -40,6 +41,7 @@ type Config struct {
 	Ratio float64 `yaml:"ratio" validate:"required,lte=1,gte=0"`
 }
 
+// Start starts telemetry exporter
 func Start(cfg Config, extraAttributes ...attribute.KeyValue) (err error) {
 	switch cfg.Protocol {
 	case "udp", "UDP":

tracing/compact_jaeger_thrift_http.go

@@ -6,13 +6,15 @@ import (
 	"go.opentelemetry.io/otel/exporters/jaeger"
 )
 
+// HTTPConfig is used to fine tune jaeger exporter to deliver spans via compact thrift protocol to collector http endpoint
 type HTTPConfig struct {
 	Endpoint string  `yaml:"endpoint"`
 	Username string  `yaml:"username"`
 	Password string  `yaml:"password"`
 	Ratio    float64 `yaml:"ratio" validate:"lte=1,gte=0"`
 }
 
+// ConfigureHTTP fine tunes jaeger exporter to deliver spans via compact thrift protocol to collector http endpoint
 func ConfigureHTTP(cfg HTTPConfig, extraAttributes ...attribute.KeyValue) (err error) {
 	if cfg.Ratio == 0 {
 		log.Debug().Msgf("Tracing disabled")

tracing/compact_jaeger_thrift_udp.go

@@ -6,6 +6,7 @@ import (
 	"go.opentelemetry.io/otel/exporters/jaeger"
 )
 
+// UDPConfig is used to fine tune jaeger exporter to deliver spans via compact thrift protocol to agent udp listener
 type UDPConfig struct {
 	// Host - sets hostname of Jaeger agent, overrides environment value of OTEL_EXPORTER_JAEGER_AGENT_HOST.
 	// Default value is `localhost`
@@ -17,6 +18,7 @@ type UDPConfig struct {
 	Ratio float64 `yaml:"ratio" validate:"required,lte=1,gte=0"`
 }
 
+// ConfigureUDP fine tunes jaeger exporter to deliver spans via compact thrift protocol to agent udp listener
 func ConfigureUDP(cfg UDPConfig, extraAttributes ...attribute.KeyValue) (err error) {
 	if cfg.Ratio == 0 {
 		log.Debug().Msgf("Tracing disabled")

tracing/exporter.go

@@ -12,6 +12,7 @@ const defaultTimeout = 10 * time.Second
 
 var exp *jaeger.Exporter
 
+// Wait allows span exporter to inhibit application shutdown until it sends all traces
 func Wait(ctx context.Context) (err error) {
 	if exp != nil {
 		<-ctx.Done()