corelog

package
v2.40.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 22, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddColor

func AddColor(level Level, message string) string

Types

type ANSIColorCode

type ANSIColorCode string
const (
	RedCode     ANSIColorCode = "\x1b[31;1m"
	GreenCode   ANSIColorCode = "\x1b[32;1m"
	YellowCode  ANSIColorCode = "\x1b[33;1m"
	BlueCode    ANSIColorCode = "\x1b[34;1m"
	MagentaCode ANSIColorCode = "\x1b[35;1m"
	ResetCode   ANSIColorCode = "\x1b[0m"
)

type EventLogFields

type EventLogFields struct {
	Timestamp string `json:"timestamp"`
	EventType string `json:"event_type"`
}

EventLogFields ...

type Level

type Level string

Level ...

const (
	// ErrorLevel ...
	ErrorLevel Level = "error"
	// WarnLevel ...
	WarnLevel Level = "warn"
	// InfoLevel ...
	InfoLevel Level = "info"
	// DoneLevel ...
	DoneLevel Level = "done"
	// NormalLevel ...
	NormalLevel Level = "normal"
	// DebugLevel ...
	DebugLevel Level = "debug"
)

type Logger

type Logger interface {
	LogMessage(message string, fields MessageLogFields)
	LogEvent(content interface{}, fields EventLogFields)
}

Logger ...

Example
package main

import (
	"os"

	"github.com/bitrise-io/bitrise/v2/log/corelog"
)

func main() {
	var logger corelog.Logger

	fields := corelog.MessageLogFields{
		Timestamp: "2022-01-01T01:01:01Z",
		Producer:  corelog.BitriseCLI,
		Level:     corelog.InfoLevel,
	}
	message := "Info message"

	logger = corelog.NewLogger(corelog.JSONLogger, os.Stdout)
	logger.LogMessage(message, fields)

	logger = corelog.NewLogger(corelog.ConsoleLogger, os.Stdout)
	logger.LogMessage(message, fields)

}
Output:
{"timestamp":"2022-01-01T01:01:01Z","type":"log","producer":"bitrise_cli","level":"info","message":"Info message"}
[2022-01-01T01:01:01Z] bitrise_cli �[34;1mInfo message�[0m

func NewLogger

func NewLogger(t LoggerType, output io.Writer) Logger

type LoggerType

type LoggerType string
const (
	JSONLogger    LoggerType = "json"
	ConsoleLogger LoggerType = "console"
)

type MessageLogFields

type MessageLogFields struct {
	Timestamp  string   `json:"timestamp"`
	Producer   Producer `json:"producer"`
	ProducerID string   `json:"producer_id,omitempty"`
	Level      Level    `json:"level"`
}

MessageLogFields ...

type Producer

type Producer string

Producer ...

const (
	// BitriseCLI ...
	BitriseCLI Producer = "bitrise_cli"
	// Step ...
	Step Producer = "step"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL