Developing a PSR-3 Logging Module for 1C-Bitrix
Investigating a production incident without proper logs is painful. The standard \Bitrix\Main\Diag\Debug::writeToFile() writes to a flat file with no structure, no levels, and no rotation. After a week of operation, the file reaches 2 GB, making analysis impossible and finding the right record a nightmare. We offer a logging module that solves this problem systematically. It writes structured records to the database, uses severity levels, tags, context, rotation, and search via the admin interface. This reduces error search time from hours to minutes. Get a consultation on implementing the logging module in your project.
Why the standard Bitrix logger is not suitable
Debug::writeToFile() mixes all events—debug, informational, and critical—into one file. No rotation—the file grows to tens of gigabytes. No search—you have to use grep on a huge file. No levels—you cannot filter only errors. This turns debugging into guesswork. Our module solves these shortcomings out of the box: structured records in ORM, PSR-3 levels, channel separation, rotation, and search.
How the logging module speeds up debugging
The module implements PSR-3, the industry standard for logging. You get a unified interface for all system components. The time to find a specific error is reduced tenfold compared to a flat file. Alerts in Telegram/Slack for critical errors allow instant reaction.
Architecture
The module vendor.logger implements the PSR-3 interface (Psr\Log\LoggerInterface), allowing it to connect to any libraries that support PSR-3: Guzzle, Doctrine, Symfony.
ORM tables:
-
b_vendor_log_entry — log records: id, level (debug/info/notice/warning/error/critical/alert/emergency), channel, message, context (JSON), extra (JSON), created_at, user_id, request_uri, ip
-
b_vendor_log_channel — channels: id, code, name, min_level, handlers (JSON), is_active
-
b_vendor_log_archive — archived records (after rotation): similar structure + archived_at
PSR-3 implementation
class BitrixLogger extends \Psr\Log\AbstractLogger
{
private string $channel;
public function __construct(string $channel = 'app')
{
$this->channel = $channel;
}
public function log($level, $message, array $context = []): void
{
if (!$this->isLevelEnabled($level)) {
return;
}
$extra = [
'user_id' => $GLOBALS['USER']?->GetID(),
'request_uri' => $_SERVER['REQUEST_URI'] ?? '',
'ip' => $_SERVER['REMOTE_ADDR'] ?? '',
];
LogEntryTable::add([
'LEVEL' => $level,
'CHANNEL' => $this->channel,
'MESSAGE' => $this->interpolate($message, $context),
'CONTEXT' => $context,
'EXTRA' => $extra,
]);
}
private function interpolate(string $message, array $context): string
{
$replace = [];
foreach ($context as $key => $val) {
$replace['{' . $key . '}'] = is_scalar($val) ? $val : json_encode($val, JSON_UNESCAPED_UNICODE);
}
return strtr($message, $replace);
}
}
Usage in code
$logger = new \Vendor\Logger\BitrixLogger('payment');
$logger->info('Payment initiated', ['order_id' => 42, 'sum' => 1500.00, 'gateway' => 'sberbank']);
$logger->error('Payment gateway error', ['order_id' => 42, 'response' => $gatewayResponse]);
// Global logger via facade
\Vendor\Logger\Log::channel('sync')->warning('1C synchronization: product not found', ['xml_id' => 'ABC-123']);
Handlers
Database writes are not the only handler. The module supports multiple handlers per channel:
- DatabaseHandler — writes to
b_vendor_log_entry (primary)
- FileHandler — writes to a file with automatic rotation (daily, max N files)
- SlackHandler — sends critical/emergency to Slack channel via Webhook
- TelegramHandler — sends alerts to a Telegram bot for level >= error
Channel configuration is stored in b_vendor_log_channel in the handlers field (JSON). Example:
{
"handlers": [
{"type": "database", "min_level": "debug"},
{"type": "telegram", "min_level": "error", "chat_id": "-100123456789"}
]
}
| Handler |
Purpose |
Minimum level |
| DatabaseHandler |
Long-term storage |
debug |
| FileHandler |
Quick access to recent logs |
debug |
| SlackHandler |
Critical error alerts |
critical |
| TelegramHandler |
Instant notifications |
error |
Rotation and archiving
The rotation agent runs once a day:
// Records older than 30 days — move to b_vendor_log_archive
// Records older than 90 days in archive — delete
// Parameters configurable in module admin interface
\Vendor\Logger\RotationAgent::run();
Transfer is done in batches of 1000 records to avoid long table locks.
PHP error interception
The module can register a global PHP error handler:
set_error_handler(function($errno, $errstr, $errfile, $errline) {
$level = ErrorLevelMapper::toLogLevel($errno);
\Vendor\Logger\Log::channel('php')->log($level, $errstr, [
'file' => $errfile,
'line' => $errline,
'errno' => $errno,
]);
return false; // Standard Bitrix handler also fires
});
set_exception_handler(function(\Throwable $e) {
\Vendor\Logger\Log::channel('php')->critical($e->getMessage(), [
'exception' => get_class($e),
'file' => $e->getFile(),
'line' => $e->getLine(),
'trace' => $e->getTraceAsString(),
]);
});
Admin interface
Log search is the primary debugging tool:
- Filter by level, channel, date, IP, user, message text
- Context search (JSON field via PostgreSQL
@> or LIKE on serialized)
- Detailed record view: full context, stack trace, request headers
- Statistics: top errors per period, dynamics by level, breakdown by channel
- Channel and handler configuration management
What is included in module development?
- Designing ORM table structures for your tasks
- Implementing a PSR-3-compatible logger
- Configuring handlers (DB, file, Slack, Telegram)
- Developing rotation and archiving agents
- Integrating global PHP error interception
- Creating an admin interface with search and statistics
- Integrating with existing code (replacing
AddMessage2Log calls)
- Operation documentation and developer instructions
- Testing on a staging environment before production deployment
We guarantee the module works on a stable codebase without surprises. With over 10 years of Bitrix development experience and 40+ successfully delivered logging modules, we build solutions that perform predictably. In one recent project for an online retailer, replacing their flat-file logging with our module cut the average time to investigate critical errors from 2 hours to under 15 minutes. Learn more about PSR-3.
Common implementation mistakes
- Forgetting to configure rotation—archive tables can grow uncontrollably.
- Setting too high a minimum level for channels (e.g., only error)—losing debugging information.
- Not integrating Telegram/Slack alerts—finding out about errors only from clients.
- Using a single channel for all events—losing context.
Development timeline
| Stage |
Duration |
| ORM tables, PSR-3 implementation |
1 day |
| DatabaseHandler, FileHandler |
1 day |
| Slack and Telegram alerts |
1 day |
| Rotation and archiving (agent) |
1 day |
| PHP error interception |
1 day |
| Admin interface, search |
2 days |
| Testing |
1 day |
Total: from 8 business days. Order a turnkey logging module—and forget about manual log parsing. Contact us for a project assessment.
1C-Bitrix Module Development and Setup
The main trap of Bitrix is init.php. You add an OnBeforeIBlockElementUpdate handler there, then another one — a year later the file is 2000 lines, and on every hit all that code executes. We move business logic into full-fledged modules with D7 ORM, custom tables, and administrative interface. The module can be disabled, transferred to another project, covered with tests — none of that is possible with init.php. Our team has 10+ years of Bitrix experience, certified specialists, and a 6-month code guarantee. Request a consultation — we'll explain how to migrate legacy code to a modular architecture.
Why is init.php the worst place for business logic?
Init.php does not support class autoloading, lacks an isolated namespace, cannot be unit tested, and cannot be disabled without editing the file itself. Every handler written there runs on every request, even if not needed. In a module, you register handlers through EventManager, and they only execute when the event occurs. Performance difference: up to 3x with 10+ handlers.
Standard Modules: Typical Problems and Solutions
Information blocks. IBlock architecture is the first thing we review on any project. A classic mistake: one catalog infoblock with 80 properties, 30 of which are multiple. The b_iblock_element_property table swells to millions of rows, and CIBlockElement::GetList with filtering on three properties does a full scan. We move reference data to Highload-blocks, eliminate multiple properties where possible, and design the structure for 5x growth.
e-Store (sale). Cart business rules are a separate story. We set discount priorities to prevent two campaigns from giving 60% instead of 30%, connect payment handlers, and write custom validation via OnSaleOrderBeforeSaved.
Search. The built-in search module with morphology works up to 10–15 thousand elements. Beyond that — Elasticsearch. We configure it via the Bitrix search module API, indexing through CSearchFullText or custom indexers.
Highload-blocks for dictionaries, logs, user data — instead of bloated IBlocks. Direct queries via Bitrix\Highloadblock\HighloadBlockTable, custom tables instead of the EAV structure of standard infoblocks. A million records — no degradation.
Mail events. Configuration is not just templates in b_event_message. The key is SPF, DKIM, DMARC on the DNS, otherwise transactional emails go to spam. We check deliverability and set up bounce handling.
How to Design Infoblocks for Performance?
We use Highload-blocks for reference data (colors, sizes, manufacturers) that are not involved in complex queries. For SKUs — a separate infoblock with linking via IBLOCK_ELEMENT_PROPERTY. Enable INDEX_PROPERTY for frequently filtered properties. Tagged caching: when an element changes, only the related cache is cleared. Highload-blocks process up to 10x faster than infoblocks with multiple properties on volumes of 100,000 records.
Custom Module Development
Each module follows the structure /local/modules/vendor.modulename/:
-
install/index.php — setup class, create tables via $DB->RunSQLBatch()
-
lib/ — D7 ORM classes, extending Bitrix\Main\ORM\Data\DataManager
-
admin/ — administrative pages using CAdminList, CAdminForm
-
include.php — autoloading, event handler registration via EventManager::getInstance()->registerEventHandler()
- REST API endpoints via
\Bitrix\Rest\RestManager
The module registers in the system, appears in the "Installed Solutions" list, and has its own settings at /bitrix/admin/settings.php?mid=vendor.modulename. It can be enabled, disabled, and updated through UpdateSystem or custom migration mechanics.
Examples of implemented tasks:
- Campaign management — visual condition builder via
CAdminCalendar, timers via agents (CAgent::AddAgent), analytics linked to the sale module
- Cost calculator — React widget on the frontend, REST API in the module, formulas stored in a Highload-block
- Booking system — real-time calendar, locking via
$DB->StartTransaction() / $DB->Commit() on concurrent requests, integration with channel manager via webhook
Components and Composite Cache
Component customization via result_modifier.php and component_epilog.php, not by editing template.php of the standard template. This way core updates are painless.
Composite cache ("Composite Site" technology) — the server sends ready HTML, bypassing PHP routing. Dynamic areas (cart, authorization) are loaded via CBitrixComponent::setFrameMode(true) and AJAX. TTFB drops to 30–50 ms. But there are caveats: not all components are compatible, $APPLICATION->ShowPanel() breaks composite, and careful markup of <div id="bx-composite-..."> is required.
What to Check Before Installing a Marketplace Module?
Before installing a module from the marketplace, an audit is mandatory. We check: SQL queries without prepared statements (hello SQL injection), direct use of $_REQUEST without filtering, use of outdated kernel API instead of D7, conflicts with the composite cache module. A module with no updates for over a year and a few dozen installations is likely a problem on the next PHP update. A typical case: a module calls CIBlockElement::GetList with no cache reset — the site crashes with 5000 elements.
Migration to D7
When upgrading PHP or switching to a new edition — refactor outdated calls:
-
CIBlockElement::GetList() → Bitrix\Iblock\Elements\ElementTable::getList()
-
CSaleOrder::GetList() → Bitrix\Sale\Order::getList()
-
CModule::IncludeModule() → Bitrix\Main\Loader::includeModule()
Testing on staging, rollback via git on issues.
According to official 1C-Bitrix documentation, D7 ORM is the recommended tool for working with data, providing type safety and automatic query generation.
Comparison: Init.php vs Module
| Criterion |
Init.php |
Module with D7 ORM |
| Performance |
Executes on every hit |
Executes only on event |
| Testability |
No autoloading, tests impossible |
Full PHPUnit support |
| Maintainability |
Codebase grows uncontrollably |
Isolated structure, versioning |
| Migrations |
None |
Custom tables, managed via install |
| Caching |
Does not support auto-invalidation |
Tagged caching, event-based clearing |
Module Development Scope and Cost
What is included in module development?
- Technical specification and architectural plan
- Code following PSR-4 and Bitrix code style
- Unit tests (PHPUnit) for business logic
- Integration tests for events and REST API
- Installation, configuration, and API documentation
- Repository and documentation access
- Administrator training for module usage
- 6-month warranty support
Estimated timelines and complexity:
| Complexity |
Examples |
Timeline |
| Simple |
Callback widget, banner system, simple calculator |
3–5 days |
| Medium |
Booking system, product configurator, review module with moderation |
1–2 weeks |
| Complex |
Multi-regionality, custom loyalty program, ERP integration |
2–4 weeks |
| Enterprise |
Marketplace platform, complex business processes with multiple roles |
1–3 months |
Cost is calculated individually — contact us for a project estimate.
Module Testing
Unit tests via PHPUnit cover business logic: discount calculation, validation, document generation. Mocks for Bitrix\Main\Application::getConnection() allow tests to be DB-independent. Integration tests verify event handlers on a real database — OnAfterIBlockElementAdd, OnSaleOrderSaved, etc. REST API endpoints are tested via curl or PHPUnit HTTP client. Critical for modules working with b_sale_order, b_catalog_price — where errors cost money.
Compatibility is checked on PHP 7.4, 8.0, 8.1, 8.2 and editions: Standard, Small Business, Business. We check conflicts with popular marketplace modules — they often intercept the same events. Load testing: measurements on 10K, 100K, 1M records, profiling via Xdebug for memory leaks and N+1 queries.
Practical Examples
Campaign module for an electronics chain. The built-in sale module discounts did not cover scenarios like "2+1", a gift with purchase over a certain amount, or combined conditions. We built a visual builder: marketers create rules via drag-and-drop without development tickets. Campaign calendar, auto-deactivation via agents, analytics linked to b_sale_order — conversion, average check, usage count. Time to launch a new campaign dropped from two days to half an hour.
Calculator for builders. Parameters (area, materials, number of floors) → formula → preliminary estimate → lead to CRM via CRest::call('crm.lead.add'). Regional coefficients and seasonal markups from a Highload-block, material prices from 1C exchange. The number of target leads increased by a third: clients see a breakdown before calling a manager.
Booking for a hotel chain. Real-time availability via AJAX requests to a custom table vendor_booking_slots, seasonal tariff calculation, synchronization with Booking.com via channel manager API. Room locking on concurrent booking via SELECT ... FOR UPDATE in transactions. Timezones handled via \DateTimeZone — a guest from Vladivostok and a manager from Moscow see the same picture.
We will evaluate your project within one day. Write to us — we'll tell you what is included in turnkey development. Contact us for a consultation on your project. Order a custom module development — get a ready solution with documentation and support.