LogService

Clears Roblox Studio's Output window. The log history is also cleared, such that LogService:GetLogHistory() will not return any entries from before the ClearOutput() call.

Logs a message at the MessageType.MessageError level and throws a structured error with optional context. As this method always throws, use LuaGlobals.pcall() to catch the error. The thrown error is a table with message, template, context, and stack fields, and a __tostring metamethod that returns the rendered message.

When a context table is provided, template placeholders like {key} in the message are replaced with the corresponding context values.

local LogService = game:GetService("LogService")

local ok, err = pcall(function()
	LogService:Error("Failed: {reason}", {reason = "timeout"})
end)
-- ok is false
-- err.message == "Failed: timeout"
-- err.context == {reason = "timeout"}
-- tostring(err) == "Failed: timeout"

Returns a table of tables, each with the message string, message type, and timestamp of a message that the client displays in the Output window. Each inner table contains the following keys:

• message (string) -- the rendered message text.
• messageType (MessageType) -- the log level (MessageOutput, MessageInfo, MessageWarning, or MessageError).
• timestamp (number) -- the time the message was emitted, in seconds.
• context (dictionary) -- the structured key-value pairs if the message was emitted via a structured logging method; absent otherwise.

The history is capped at a maximum of 512 entries by default. Calling LogService:ClearOutput() empties the history, so subsequent calls return only entries logged after the clear.

Logs a message at the MessageType.MessageInfo level. When a context table is provided, template placeholders like {key} in the message are replaced with the corresponding context values. The context is preserved as structured data for display in the Developer Console and Studio's Output window.

local LogService = game:GetService("LogService")

LogService:Info("User {name} has {count} items", {name = "Alice", count = 42})
-- Output: "User Alice has 42 items"

Logs a message at the specified MessageType level. This is a general-purpose method that combines the functionality of Output(), Info(), Warn(), and Error() into a single call with an explicit message type parameter.

When messageType is MessageType.MessageError, this method throws a structured error object (same behavior as Error()).

local LogService = game:GetService("LogService")

LogService:Log(Enum.MessageType.MessageInfo, "Event {action}", {action = "click"})

Logs a message at the MessageType.MessageOutput level. When a context table is provided, template placeholders like {key} in the message are replaced with the corresponding context values. The context is preserved as structured data for display in the Developer Console and Studio's Output window.

local LogService = game:GetService("LogService")

LogService:Output("Player {name} joined", {name = "Alice"})
-- Output: "Player Alice joined"

Logs a message at the MessageType.MessageWarning level with optional structured context. When a context table is provided, template placeholders like {key} in the message are replaced with the corresponding context values. The context is preserved as structured data for display in the Developer Console and Studio's Output window.

local LogService = game:GetService("LogService")

LogService:Warn("Memory usage at {pct}%", {pct = 95})
-- Output: "Memory usage at 95%"

Fires whenever a message is logged through the engine's output system, including calls to LuaGlobals.print(), RobloxGlobals.warn(), and the structured logging methods on LogService. The message parameter contains the fully rendered text (template placeholders already replaced). The context parameter carries the structured key-value pairs when the message was emitted via a method that accepts a context table; otherwise it is nil.

local LogService = game:GetService("LogService")

LogService.MessageOut:Connect(function(message, messageType, context)
	if messageType == Enum.MessageType.MessageError then
		print("Error:", message)
	end
	if context then
		-- Access structured data from structured logging calls
		for key, value in context do
			print(key, "=", value)
		end
	end
end)