Namespace Unity.Logging

Classes

Console

Static class for Console related operations. Provides Write(Byte*, Int32, Byte), Write(ref FixedString512Bytes) and Write(ref FixedString4096Bytes) for low-level writing to the Console. Use BeginBatch() and EndBatch() when you need to write a lot of data in a batch.

Consts

FixedString representation of LogLevel

Logger

Main class of Logging library. Contains Sinks, unique identifier LoggerHandle

LoggerConfig

Configuration for Logger. Can be used to setup Logger and create it.

LoggerMinimumLevelConfig

Use to set the minimum log level that you want to use.

LoggerWriterConfig

Config for the sink creation

LogLevelUtilsBurstCompatible

Static class with utility burst compatible functions for LogLevel - FixedString32Bytes convertion

Structs

Builder

Helper struct that helps pack data into LogMemoryManager Will be extended by Source Generator (that's why it is partial)

DispatchQueue

Double buffered thread-safe queue that is used by com.unity.logging. One buffer is used for write: several threads can add new LogMessage's to it Second one is used as read-only buffer: sinks and logging system's cleanup system read it. Cleanup system calls EndReadClearAndFlip() at the end of its work, cleaning read-only buffer and flipping write/read-only ones.

LogController

Burst-friendly backend for Logger that contains LoggerHandle, LogMemoryManager, DispatchQueue and is able to answer if this particular LogLevel is supported by this Logger.

LogDecorateScope

Disposable struct that adds Decorations to the logs in the scope, or to some particular log

LoggerHandle

Structure that contains unique identifier of Logger

LogMemoryManager

Interface for allocating and managing Payload buffers for LogMessage.

LogMemoryManagerParameters

Initialization parameters for LogMemoryManager.

LogMessage

The struct for dispatching and processing log messages.

PayloadHandle

Holds a 64-bit value that uniquely references an allocated memory block within LogMemoryManager.

PayloadLockContext

Holds a value to identify a specific "context" for a Payload buffer lock.

SpinLockExclusive

Burst-friendly synchronization primitive

SpinLockExclusive.ScopedLock

SpinLockReadWrite

Burst-friendly synchronization primitive that supports read lock and exclusive (write) lock

SpinLockReadWrite.ScopedExclusiveLock

SpinLockReadWrite.ScopedReadLock

TextLoggerParser

Parser logic

TextLoggerParser.ArgumentInfo

Parsed Argument/Hole data

UnsafePayloadRingBuffer

Logging system's primary container for allocating Payload buffers.

Enums

LogLevel

Log Level

PayloadReleaseResult

Result value returned when releasing Payload buffers.

TextLoggerParser.ArgumentInfo.DestructingType

Enum for the name - with @, with $ or without

TextLoggerParser.ContextWriteResult

Result values returned by an OutputWriteHandler implementer.

Delegates

TextLoggerParser.OutputWriterHandler

Defines a delegate to handle writing the field data for context data structs.

TextLoggerParser.OutputWriterLevelHandler

Defines a delegate to handle writing the LogLevel

TextLoggerParser.OutputWriterTimestampHandler

Defines a delegate to handle writing the timestamp