logart

Logart

Logart is a structured logging tool that aims to simplify logging to a database

It is not yet in stable state, but is used in production and actively developped.

All contributions are welcome, please feel free to raise an issue or make a PR.

Example

API is a struct containing a database connection that has a method for logging all the fields you need.

Code

// CreateItem is a request for creating an item
func (api *API) CreateItem(w http.ResponseWriter, r *http.Request) {
	// Get information we need from the context
	s := session.FromContext(r)

	// unmarshal the payload
	i := &db.Item{}
	json.NewDecoder(r.Body).Decode(i)
	io.Copy(io.Discard, r.Body)

	// create an audit of the access
	logart.Read().
		With("user", s.UserID).
		With("reference", i.Reference).
		Commit(api.LogRequest(r.Context()))
}

// LogRequest logs the request
func (api *API) LogRequest(ctx context.Context) func(l *logart.Log) error {
	return func(l *logart.Log) error {
		return api.DB.Log(ctx, db.LogParams{
			Timestamp: l.Timestamp,
			Event:     l.Event,
			Content:   l.FieldString("reference"),
			User:      l.FieldInt64("user"),
		})
	}
}

SQL

-- query
-- name: Log :exec
INSERT INTO "transactions" ("timestamp", "reference", "user", "event")
VALUES ($1, $2, $3, $4);

-- schema
CREATE TABLE "public"."transactions" (
    "id" serial PRIMARY KEY,
    "timestamp" timestamp NOT NULL,
    "reference" varchar,
    "event" varchar NOT NULL,
    "user" integer NOT NULL
);