lokilogger

README

LokiLogger Package for writing logs to Loki

Description

This package (lokilogger) provides a convenient mechanism for writing logs to Loki (Loki is a log aggregation system from Grafana Labs) using the standard log package. It allows grouping logs into packages (batching), adding metadata (service name), and automatically reconnecting to Loki when the connection is lost.

Features

• Batched Sending: Reduces load on the Loki server and improves efficiency.
• Automatic Reconnect: Ensures continuous logging in case of connection breaks with Loki.
• Access Token Support: Allows for secure access to Loki.
• Easy Integration: Simply replaces the standard log.Print, log.Println, log.Printf for convenient logging.

Getting started

Getting LokiLogger

go get github.com/LynxXIII/loki_logger

Running LokiLogger

A basic example:

package main

import (
	"context"
	"fmt"
	"os"
	"log"

	lokilogger "github.com/LynxXIII/loki_logger"
)

func main() {
	ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Second*10))
	defer cancel()

	cfg := lokilogger.Config{
		Name:       	"Service Name",
		URL:        	"http://loki:3100/loki/api/v1/push", // Replace with your Loki URL
		BatchSize: 		20,
		FlushInterval: 	5 * time.Second,
		RetryCount:    	2,
		//AccessToken: 	"YOUR_LOKI_ACCESS_TOKEN", // Optional if you have an Access Token
	}

	if err := lokilogger.Init(ctx, cfg); err != nil {
		fmt.Println("Error:", err)
		os.Exit(1)
	}

	log.Println("Starting service...")
	log.Println("This is a sample log message.")
	log.Println("Another log message with more details.")
}

Important Notes:

Replace "http://loki:3100/loki/api/v1/push" with the actual URL of your Loki instance. Comment out the AccessToken line if you're not using access tokens with Loki. Access tokens are used for authentication.

Configuration Parameters (Config struct)

• Name: The name of your service, which will be displayed in Loki.
• URL: The URL of the Loki API endpoint for receiving logs.
• BatchSize: The number of logs to collect into a single batch before sending. Optimize this value to achieve the best balance between latency and throughput.
• AccessToken: An access token for authenticated access to Loki (optional).

License: The MIT License.

Documentation

Index

• func Init(ctx context.Context, cfg Config) error
• type Config
• type LokiLogger
  • func (l *LokiLogger) Flush()
  • func (l *LokiLogger) Shutdown()
  • func (l *LokiLogger) Write(p []byte) (n int, err error)
• type LokiStream

Functions

func Init

func Init(ctx context.Context, cfg Config) error

Initializes.

Types

type Config

type Config struct {
	Name          string // Service name used for identification of logs in Loki.
	URL           string // Loki API server endpoint URL.
	BatchSize     int    // Number of logs to batch before sending to Loki.
	AccessToken   string // Authentication token for accessing the Loki API.
	FlushInterval time.Duration
	RetryCount    int
}

Config Structure holds Loki specific configuration parameters.

type LokiLogger

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

LokiLogger Structure represents a logger to Loki.

func (*LokiLogger) Flush

func (l *LokiLogger) Flush()

Sends the log data to the Loki API server.

func (*LokiLogger) Shutdown

func (l *LokiLogger) Shutdown()

func (*LokiLogger) Write

func (l *LokiLogger) Write(p []byte) (n int, err error)

Write implements the io.Writer interface and writes data to the Loki API server.

type LokiStream

type LokiStream struct {
	Stream map[string]string `json:"stream"` // Key-value pairs to identify log stream.
	Values [][2]string       `json:"values"` // Array of log values with timestamp and log message.
}

LokiLogger Structure represents Loki Log Logger.