golog2tgm

package module

v0.2.2 Latest Latest Go to latest Published: Jan 19, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

The module is intended to act as a logger sink to gather message samples and periodically send them via Telegram

This section is empty.

This section is empty.

This section is empty.

type Worker struct {
	// contains filtered or unexported fields
}

func Start(
	ctx context.Context,
	srcRoot string,
	intro func(int8, int) string,
	errorHandler func(string),
) *Worker

Start worker.

srcRoot is a common part of the sources path being printed in a call stack (to exclude external calls and to truncate long paths).

intro arg is a callback to print an intro with prefered design.

errorHandler allows to log golog2tgm internal errors with a logger being used by a caller.

func (w *Worker) PushMessage(level int8, hash uint64, msg string, pcs []uintptr)

Push message to the engine.

hash allows to identify a sample externally, e.g. via program counter. Pass 0 to match samples by golog2tgm.

pcs allows to add call stack to the sample.

func (w *Worker) SetCaption(caption string)

Set teleram message caption (e.g. your daemon name)

func (w *Worker) SetPeriod(periodSec uint)

Set alerting interval in seconds

func (w *Worker) SetTargetChat(apiToken string, id int64)

func (w *Worker) SetTimeZone(name string, offsetSec int)

Set convenient time zone and its UTC offset in seconds

func (w *Worker) Stop()

Synchronously send messages that have not yet been sent and stop the worker.

func (w *Worker) Uncork()

Force send aggregated alerts