---
title: "Phalcon Logger"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Logger
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Logger\AbstractLogger
Abstract
Abstract Logger Class
Abstract logger class, providing common functionality. A formatter interface
is available as well as an adapter one. Adapters can be created easily using
the built in AdapterFactory. A LoggerFactory is also available that allows
developers to create new instances of the Logger or load them from config
files (see Phalcon\Config\Config object).
@property AdapterInterface[] $adapters
@property array $excluded
@property int $logLevel
@property string $name
@property DateTimeZone $timezone
- **`Phalcon\Logger\AbstractLogger`**
- [`Phalcon\Logger\Logger`](#loggerlogger)
`DateTimeZone` · `Exception` · `Phalcon\Logger\Adapter\AdapterInterface` · `Phalcon\Logger\Exceptions\AdapterNotFound` · `Phalcon\Logger\Exceptions\NoAdaptersConfigured` · `Phalcon\Time\Clock\ClockInterface` · `Phalcon\Time\Clock\SystemClock`
### Method Summary
Constructor.
Add an adapter to the stack. For processing we use FIFO
Starts a transaction on every (non-excluded) adapter in the stack.
Commits the transaction on every (non-excluded) adapter in the stack.
Exclude certain adapters.
Returns an adapter from the stack
Returns the adapter stack array
Returns the log level
Returns the name of the logger
Removes an adapter from the stack
Rolls back the transaction on every (non-excluded) adapter in the stack.
Sets the adapters stack overriding what is already there
Sets the minimum log level for the logger.
Adds a message to each handler for processing
Converts the level from string/word to an integer
Returns an array of log levels with integer to string conversion
### Constants
Default threshold and fallback sink. It sits between DEBUG (7) and
TRACE (9) in the ordering, so the default log level excludes TRACE.
It is also the fallback for unknown message levels and invalid
setLogLevel() values.
### Properties
The adapter stack
Clock used to timestamp log items
The excluded adapters for this log process
Minimum log level for the logger
### Methods
__construct()
```php
public function __construct(
string $name,
array $adapters = [],
DateTimeZone|null $timezone = null,
ClockInterface|null $clock = null
);
```
Constructor.
addAdapter()
```php
public function addAdapter(
string $name,
AdapterInterface $adapter
): static;
```
Add an adapter to the stack. For processing we use FIFO
begin()
```php
public function begin(): static;
```
Starts a transaction on every (non-excluded) adapter in the stack.
commit()
```php
public function commit(): static;
```
Commits the transaction on every (non-excluded) adapter in the stack.
excludeAdapters()
```php
public function excludeAdapters( array $adapters = [] ): static;
```
Exclude certain adapters.
getAdapter()
```php
public function getAdapter( string $name ): AdapterInterface;
```
Returns an adapter from the stack
getAdapters()
```php
public function getAdapters(): array;
```
Returns the adapter stack array
getLogLevel()
```php
public function getLogLevel(): int;
```
Returns the log level
getName()
```php
public function getName(): string;
```
Returns the name of the logger
removeAdapter()
```php
public function removeAdapter( string $name ): static;
```
Removes an adapter from the stack
rollback()
```php
public function rollback(): static;
```
Rolls back the transaction on every (non-excluded) adapter in the stack.
setAdapters()
```php
public function setAdapters( array $adapters ): static;
```
Sets the adapters stack overriding what is already there
setLogLevel()
```php
public function setLogLevel( int $level ): static;
```
Sets the minimum log level for the logger.
An unknown level is not rejected: it is stored as CUSTOM, which sits
between DEBUG and TRACE in the ordering, so the threshold becomes
"everything except TRACE".
addMessage()
```php
protected function addMessage(
int $level,
string $message,
array $context = []
): bool;
```
Adds a message to each handler for processing
getLevelNumber()
```php
protected function getLevelNumber( mixed $level ): int;
```
Converts the level from string/word to an integer
getLevels()
```php
protected function getLevels(): array;
```
Returns an array of log levels with integer to string conversion
## Logger\AdapterFactory
Class
Factory used to create adapters used for Logging
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Logger\AdapterFactory`**
`Exception` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Logger\Adapter\AdapterInterface` · `Phalcon\Logger\Adapter\Noop` · `Phalcon\Logger\Adapter\Stream` · `Phalcon\Logger\Adapter\Syslog` · `Throwable`
### Method Summary
AdapterFactory constructor.
Create a new instance of the adapter
Returns the available adapters
### Methods
__construct()
```php
public function __construct( array $services = [] );
```
AdapterFactory constructor.
newInstance()
```php
public function newInstance(
string $name,
string $fileName,
array $options = []
): AdapterInterface;
```
Create a new instance of the adapter
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Logger\Adapter\AbstractAdapter
Abstract
Class AbstractAdapter
- **`Phalcon\Logger\Adapter\AbstractAdapter`** - implements [`Phalcon\Logger\Adapter\AdapterInterface`](#loggeradapteradapterinterface)
- [`Phalcon\Logger\Adapter\Noop`](#loggeradapternoop)
- [`Phalcon\Logger\Adapter\Stream`](#loggeradapterstream)
- [`Phalcon\Logger\Adapter\Syslog`](#loggeradaptersyslog)
`Phalcon\Logger\Exceptions\DeserializationFailed` · `Phalcon\Logger\Exceptions\SerializationFailed` · `Phalcon\Logger\Exceptions\TransactionAlreadyActive` · `Phalcon\Logger\Exceptions\TransactionNotActive` · `Phalcon\Logger\Formatter\FormatterInterface` · `Phalcon\Logger\Formatter\Line` · `Phalcon\Logger\Item`
### Method Summary
Destructor cleanup
Prevent serialization
Prevent unserialization
Adds a message to the queue
Starts a transaction
Closes the logger
Commits the internal transaction
Return the formatter used
Returns the configured transaction-queue cap (0 = unlimited)
Returns the whether the logger is currently in an active transaction or
Processes the message in the adapter
Rollbacks the internal transaction
Sets the message formatter
Sets the maximum number of items retained in the transaction
Returns the formatted item
### Properties
Name of the default formatter class
Formatter
Tells if there is an active transaction or not
Array with messages queued in the transaction
Maximum number of items retained in the transaction queue.
0 (default) keeps the original unbounded behavior; a positive
value drops the oldest queued item FIFO before a new one is
appended in add().
### Methods
__destruct()
```php
public function __destruct();
```
Destructor cleanup
Throwing from a destructor is fatal during script shutdown, so an open
transaction is auto-committed here (flushing the queued items) rather
than throwing.
__serialize()
```php
public function __serialize(): array;
```
Prevent serialization
__unserialize()
```php
public function __unserialize( array $data ): void;
```
Prevent unserialization
add()
```php
public function add( Item $item ): AdapterInterface;
```
Adds a message to the queue
begin()
```php
public function begin(): AdapterInterface;
```
Starts a transaction
close()
```php
abstract public function close(): bool;
```
Closes the logger
commit()
```php
public function commit(): AdapterInterface;
```
Commits the internal transaction
```php
public function getFormatter(): FormatterInterface;
```
Return the formatter used
getQueueLimit()
```php
public function getQueueLimit(): int;
```
Returns the configured transaction-queue cap (0 = unlimited)
inTransaction()
```php
public function inTransaction(): bool;
```
Returns the whether the logger is currently in an active transaction or
not
process()
```php
abstract public function process( Item $item ): void;
```
Processes the message in the adapter
rollback()
```php
public function rollback(): AdapterInterface;
```
Rollbacks the internal transaction
```php
public function setFormatter( FormatterInterface $formatter ): AdapterInterface;
```
Sets the message formatter
setQueueLimit()
```php
public function setQueueLimit( int $queueLimit ): AdapterInterface;
```
Sets the maximum number of items retained in the transaction
queue. 0 disables the cap (the default; preserves the original
unbounded behavior).
```php
protected function getFormattedItem( Item $item ): string;
```
Returns the formatted item
## Logger\Adapter\AdapterInterface
Interface
Phalcon\Logger\AdapterInterface
Interface for Phalcon\Logger adapters
- [`Phalcon\Contracts\Logger\Adapter\Adapter`](/5.20/api/phalcon_contracts/#contractsloggeradapteradapter)
- **`Phalcon\Logger\Adapter\AdapterInterface`**
`Phalcon\Contracts\Logger\Adapter\Adapter`
## Logger\Adapter\Exceptions\FileOpenFailed
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Adapter\Exceptions\FileOpenFailed`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct(
string $name,
string $mode
);
```
## Logger\Adapter\Exceptions\InvalidStreamMode
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Adapter\Exceptions\InvalidStreamMode`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Logger\Adapter\Exceptions\SyslogOpenFailed
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Adapter\Exceptions\SyslogOpenFailed`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct(
string $name,
int $facility
);
```
## Logger\Adapter\Noop
Class
Class Noop
@package Phalcon\Logger\Adapter
- [`Phalcon\Logger\Adapter\AbstractAdapter`](#loggeradapterabstractadapter)
- **`Phalcon\Logger\Adapter\Noop`**
`Phalcon\Logger\Item`
### Method Summary
Closes the stream
Processes the message i.e. writes it to the file
### Methods
close()
```php
public function close(): bool;
```
Closes the stream
process()
```php
public function process( Item $item ): void;
```
Processes the message i.e. writes it to the file
## Logger\Adapter\Stream
Class
Phalcon\Logger\Adapter\Stream
Adapter to store logs in plain text files
```php
$logger = new \Phalcon\Logger\Adapter\Stream('app/logs/test.log');
$logger->log('This is a message');
$logger->log(\Phalcon\Logger\Enum::ERROR, 'This is an error');
$logger->error('This is another error');
$logger->close();
```
@property resource|null $handler
@property string $mode
@property string $name
- [`Phalcon\Logger\Adapter\AbstractAdapter`](#loggeradapterabstractadapter)
- **`Phalcon\Logger\Adapter\Stream`**
`Phalcon\Logger\Adapter\Exceptions\FileOpenFailed` · `Phalcon\Logger\Adapter\Exceptions\InvalidStreamMode` · `Phalcon\Logger\Exception` · `Phalcon\Logger\Item` · `Phalcon\Traits\Php\FileTrait`
### Method Summary
Stream constructor.
Closes the stream
Stream name
Processes the message i.e. writes it to the file
### Properties
Stream handler resource
The file open mode. Defaults to 'ab'
Stream name
### Methods
__construct()
```php
public function __construct(
string $name,
array $options = []
);
```
Stream constructor.
close()
```php
public function close(): bool;
```
Closes the stream
getName()
```php
public function getName(): string;
```
Stream name
process()
```php
public function process( Item $item ): void;
```
Processes the message i.e. writes it to the file
## Logger\Adapter\Syslog
Class
Class Syslog
@property string $defaultFormatter
@property int $facility
@property string $name
@property bool $opened
@property int $option
- [`Phalcon\Logger\Adapter\AbstractAdapter`](#loggeradapterabstractadapter)
- **`Phalcon\Logger\Adapter\Syslog`**
`Phalcon\Logger\Adapter\Exceptions\SyslogOpenFailed` · `Phalcon\Logger\Enum` · `Phalcon\Logger\Item`
### Method Summary
Syslog constructor.
Closes the logger
Processes the message i.e. writes it to the syslog
Open connection to system logger
### Properties
### Methods
__construct()
```php
public function __construct(
string $name,
array $options = []
);
```
Syslog constructor.
close()
```php
public function close(): bool;
```
Closes the logger
process()
```php
public function process( Item $item ): void;
```
Processes the message i.e. writes it to the syslog
openlog()
```php
protected function openlog(
string $ident,
int $option,
int $facility
): bool;
```
Open connection to system logger
## Logger\Enum
Class
Log Level Enum constants
- **`Phalcon\Logger\Enum`**
### Constants
Default threshold and fallback sink. It sits between DEBUG (7) and
TRACE (9) in the ordering, so the default log level excludes TRACE.
It is also the fallback for unknown message levels and invalid
setLogLevel() values.
## Logger\Exception
Class
Phalcon\Logger\Exception
Exceptions thrown in Phalcon\Logger will use this class
- `\Exception`
- **`Phalcon\Logger\Exception`**
- [`Phalcon\Logger\Adapter\Exceptions\FileOpenFailed`](#loggeradapterexceptionsfileopenfailed)
- [`Phalcon\Logger\Adapter\Exceptions\InvalidStreamMode`](#loggeradapterexceptionsinvalidstreammode)
- [`Phalcon\Logger\Adapter\Exceptions\SyslogOpenFailed`](#loggeradapterexceptionssyslogopenfailed)
- [`Phalcon\Logger\Exceptions\AdapterNotFound`](#loggerexceptionsadapternotfound)
- [`Phalcon\Logger\Exceptions\DeserializationFailed`](#loggerexceptionsdeserializationfailed)
- [`Phalcon\Logger\Exceptions\NoAdaptersConfigured`](#loggerexceptionsnoadaptersconfigured)
- [`Phalcon\Logger\Exceptions\SerializationFailed`](#loggerexceptionsserializationfailed)
- [`Phalcon\Logger\Exceptions\TransactionAlreadyActive`](#loggerexceptionstransactionalreadyactive)
- [`Phalcon\Logger\Exceptions\TransactionNotActive`](#loggerexceptionstransactionnotactive)
## Logger\Exceptions\AdapterNotFound
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Exceptions\AdapterNotFound`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $name );
```
## Logger\Exceptions\DeserializationFailed
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Exceptions\DeserializationFailed`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Logger\Exceptions\NoAdaptersConfigured
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Exceptions\NoAdaptersConfigured`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
```php
public function __construct();
```
## Logger\Exceptions\SerializationFailed
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Exceptions\SerializationFailed`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Logger\Exceptions\TransactionAlreadyActive
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Exceptions\TransactionAlreadyActive`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Logger\Exceptions\TransactionNotActive
Class
- `\Exception`
- [`Phalcon\Logger\Exception`](#loggerexception)
- **`Phalcon\Logger\Exceptions\TransactionNotActive`**
`Phalcon\Logger\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Logger\Formatter\AbstractFormatter
Abstract
Class AbstractFormatter
- **`Phalcon\Logger\Formatter\AbstractFormatter`** - implements [`Phalcon\Logger\Formatter\FormatterInterface`](#loggerformatterformatterinterface)
- [`Phalcon\Logger\Formatter\Json`](#loggerformatterjson)
- [`Phalcon\Logger\Formatter\Line`](#loggerformatterline)
`DateTimeImmutable` · `Phalcon\Logger\Item` · `Phalcon\Traits\Support\Helper\Str\InterpolateTrait`
### Method Summary
Returns the date formatted for the logger.
Returns the interpolated message, replacing context placeholders.
### Properties
Default date format
### Methods
```php
public function getDateFormat(): string;
```
```php
public function setDateFormat( string $format ): void;
```
```php
protected function getFormattedDate( Item $item ): string;
```
Returns the date formatted for the logger.
```php
protected function getInterpolatedMessage(
Item $item,
string $message
): string;
```
Returns the interpolated message, replacing context placeholders.
## Logger\Formatter\FormatterInterface
Interface
Phalcon\Logger\FormatterInterface
This interface must be implemented by formatters in Phalcon\Logger
- [`Phalcon\Contracts\Logger\Formatter\Formatter`](/5.20/api/phalcon_contracts/#contractsloggerformatterformatter)
- **`Phalcon\Logger\Formatter\FormatterInterface`**
`Phalcon\Contracts\Logger\Formatter\Formatter`
## Logger\Formatter\Json
Class
Formats messages using JSON encoding
- [`Phalcon\Logger\Formatter\AbstractFormatter`](#loggerformatterabstractformatter)
- **`Phalcon\Logger\Formatter\Json`**
`JsonException` · `Phalcon\Logger\Item` · `Phalcon\Traits\Support\Helper\Json\EncodeTrait`
### Method Summary
Json constructor.
Applies a format to a message before sent it to the internal log
### Methods
```php
public function __construct(
string $dateFormat = "c",
string $interpolatorLeft = "%",
string $interpolatorRight = "%"
);
```
Json constructor.
```php
public function format( Item $item ): string;
```
Applies a format to a message before sent it to the internal log
## Logger\Formatter\Line
Class
Class Line
- [`Phalcon\Logger\Formatter\AbstractFormatter`](#loggerformatterabstractformatter)
- **`Phalcon\Logger\Formatter\Line`**
`Exception` · `Phalcon\Logger\Item`
### Method Summary
Line constructor.
Applies a format to a message before sent it to the internal log
Return the format applied to each message
Set the format applied to each message
### Properties
Format applied to each message
### Methods
```php
public function __construct(
string $format = "[%date%][%level%] %message%",
string $dateFormat = "c",
string $interpolatorLeft = "%",
string $interpolatorRight = "%"
);
```
Line constructor.
```php
public function format( Item $item ): string;
```
Applies a format to a message before sent it to the internal log
```php
public function getFormat(): string;
```
Return the format applied to each message
```php
public function setFormat( string $format ): static;
```
Set the format applied to each message
## Logger\Item
Class
Phalcon\Logger\Item
Represents each item in a logging transaction
- **`Phalcon\Logger\Item`**
`DateTimeImmutable`
### Method Summary
Item constructor.
### Properties
### Methods
__construct()
```php
public function __construct(
string $message,
string $levelName,
int $level,
DateTimeImmutable $dateTime,
array $context = []
);
```
Item constructor.
getContext()
```php
public function getContext(): array;
```
getDateTime()
```php
public function getDateTime(): DateTimeImmutable;
```
getLevel()
```php
public function getLevel(): int;
```
getLevelName()
```php
public function getLevelName(): string;
```
getMessage()
```php
public function getMessage(): string;
```
## Logger\Logger
Class
Phalcon Logger.
A logger, with various adapters and formatters. A formatter
interface is available as well as an adapter one. Adapters can be created
easily using the built-in AdapterFactory. A LoggerFactory is also available
that allows developers to create new instances of the Logger or load them
from config files (see Phalcon\Config\Config object).
- [`Phalcon\Logger\AbstractLogger`](#loggerabstractlogger)
- **`Phalcon\Logger\Logger`** - implements [`Phalcon\Logger\LoggerInterface`](#loggerloggerinterface)
### Method Summary
Action must be taken immediately.
Critical conditions.
Detailed debug information.
System is unusable.
Runtime errors that do not require immediate action but should typically
Interesting events.
Logs with an arbitrary level.
Normal but significant events.
Extra-verbose diagnostic output.
Exceptional occurrences that are not errors.
### Methods
alert()
```php
public function alert(
string $message,
array $context = []
): void;
```
Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should
trigger the SMS alerts and wake you up.
critical()
```php
public function critical(
string $message,
array $context = []
): void;
```
Critical conditions.
Example: Application component unavailable, unexpected exception.
debug()
```php
public function debug(
string $message,
array $context = []
): void;
```
Detailed debug information.
emergency()
```php
public function emergency(
string $message,
array $context = []
): void;
```
System is unusable.
error()
```php
public function error(
string $message,
array $context = []
): void;
```
Runtime errors that do not require immediate action but should typically
be logged and monitored.
info()
```php
public function info(
string $message,
array $context = []
): void;
```
Interesting events.
Example: User logs in, SQL logs.
log()
```php
public function log(
mixed $level,
string $message,
array $context = []
): void;
```
Logs with an arbitrary level.
An unknown level (a typo or an unmapped value) is not rejected; it maps
to the CUSTOM level and is logged, rather than raising an exception.
notice()
```php
public function notice(
string $message,
array $context = []
): void;
```
Normal but significant events.
trace()
```php
public function trace(
string $message,
array $context = []
): void;
```
Extra-verbose diagnostic output.
Use for high-frequency, fine-grained events such as raw socket frames,
HTTP response bodies, or internal state transitions that are too noisy
for DEBUG.
warning()
```php
public function warning(
string $message,
array $context = []
): void;
```
Exceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things
that are not necessarily wrong.
## Logger\LoggerFactory
Class
Factory creating logger objects
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- **`Phalcon\Logger\LoggerFactory`**
`DateTimeZone` · `Exception` · `Phalcon\Config\ConfigInterface` · `Phalcon\Factory\AbstractConfigFactory` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `Throwable`
### Method Summary
Constructor
Factory to create an instance from a Config object
Returns a Logger object
### Methods
__construct()
```php
public function __construct( AdapterFactory $factory );
```
Constructor
load()
```php
public function load( mixed $config ): Logger;
```
Factory to create an instance from a Config object
newInstance()
```php
public function newInstance(
string $name,
array $adapters = [],
DateTimeZone|null $timezone = null
): Logger;
```
Returns a Logger object
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
## Logger\LoggerInterface
Interface
Interface for Phalcon based logger objects.
- [`Phalcon\Contracts\Logger\Logger`](/5.20/api/phalcon_contracts/#contractsloggerlogger)
- **`Phalcon\Logger\LoggerInterface`**
`Phalcon\Contracts\Logger\Logger`
Source: https://docs.phalcon.io/5.20/api/phalcon_logger/index.mdx