Commandcracker/CC-Logging

An logging library for Computer Craft

CC-Logging

An logging library for Computer Craft

WARNING: Please Do not use CC-Logging in production, because it's currently in development!

• All Handler's will be reworked.
• Some classes will be renamed.
• Log levels will completely be overhauled.

Example

look at the Documentation for moor help and please remind that the documentation is incomplete.

local logging = require("logging")
local logger  = logging.Logger.new(shell.getRunningProgram())

logger:debug("debug message")
logger:info("info message")
logger:warn("warn message")
logger:error("error message")
logger:critical("critical message")

Custom Handler

local logging = require("logging")
local logger  = logging.Logger.new(shell.getRunningProgram())

local CustomHandler = {}

function CustomHandler.new(formatter)
    return setmetatable({ formatter = formatter }, { __index = CustomHandler })
end

function CustomHandler:handle(record)
    local old_text_color       = term.getTextColor()
    local old_background_color = term.getBackgroundColor()

    term.setTextColor(record.level.textcolor)
    term.setBackgroundColor(record.level.backgroundcolor)

    -- example functionality: reverse every message
    record.message = string.reverse(record.message)
    write(self.formatter:format(record))

    term.setTextColor(old_text_color)
    term.setBackgroundColor(old_background_color)

    write("\n")
end

logger:addHandler(CustomHandler.new(logger.formatter))

logger:info("Message Handeld by Custom Handler")

Websocket Example

Server

const WebSocket = require('ws');
const server    = new WebSocket.Server({
    port: 8080
});

let sockets = [];

server.on('connection', function (socket) {
    sockets.push(socket);

    // When you receive a message, log it
    socket.on('message', function (msg) {
        console.log(msg.toString());
    });

    // When a socket closes, or disconnects, remove it from the array.
    socket.on('close', function () {
        sockets = sockets.filter(s => s !== socket);
    });
});

Client

local logging          = require("logging")
local logger           = logging.Logger.new(shell.getRunningProgram())
local websocket        = http.websocket("ws://127.0.0.1:8080")
local websocketHandler = logging.ColordWebsocketHandler.new(logger.formatter, websocket)
logger:addHandler(websocketHandler)

-- Default log Levels

logger:debug("logging.debug")
logger:info("logging.info")
logger:warn("logging.warn")
logger:error("logging.error")
logger:critical("logging.critical")

local function blankLine()
    websocket.send(" ")
    print()
end

-- Custom Level

blankLine()

local level = logging.Level.new {
    name            = "CUSTOM",
    textcolor       = colors.black,
    backgroundcolor = colors.white
}
logger:log(level, "custom level")

-- Custom Formatter

blankLine()

local formatter = logging.Formatter.new(
    "[%(time) %(name) %(levelname)] %(message)",
    "%Y-%m-%d %H:%M:%S"
)

local custom_logger = logging.Logger.new {
    name      = shell.getRunningProgram(),
    formatter = formatter
}

local custom_websocketHandler = logging.ColordWebsocketHandler.new(formatter, websocket)
custom_logger:addHandler(custom_websocketHandler)

custom_logger:info("custom formatter")

-- All Colors as log Levels

blankLine()

for key, value in pairs(colors) do
    if type(value) == "number" then
        logger:log(
            logging.Level.new(
                key:gsub("^%l", key.upper),
                20,
                value,
                value == colors.black and colors.white or colors.black
            ),
            key,
            value
        )
    end
end

websocket.close()