Message Logs

Message Logs is the tool behind Log Extender. Companion copies the message processing logs of a tenant, with their attachments, custom headers and error details, before the tenant deletes them after 30 days. You search them with the filters you know from the Cloud Integration monitor.

Turn it on

Log sync is off for every tenant until you switch it on: Message Logs → Settings → Sync.

Setting	Default	Meaning
Log sync enabled	off	Starts and stops the collection for this tenant.
Poll interval	120 seconds	How often Companion asks the tenant for new logs.
Retention	365 days	How long logs are kept. 0 keeps everything. Whole months expire, so 365 days keeps 12 to 13 months.
Steps policy	failed	For which messages the run steps are stored: none, failed messages, or all. More steps mean more API calls.
Archive expired periods	off	Move expired months to the archive directory instead of deleting them. Needs COMPANION_ARCHIVE_DIR: see Configuration.
Storage quota	unlimited	Upper limit of what this tenant may hold on the data volume.

When you turn it on for the first time, Companion goes back as far as the tenant still has logs, so up to 30 days. The same page shows the state of the sync: the last poll, how far behind it is, the progress of the first backfill and the queue of attachments still to fetch.

Search

The monitor lists messages newest first. Filters, all of which are part of the URL, so a search can be sent to a colleague:

• time range, status, package and integration flow;
• message ID, correlation ID, application message ID and type, sender, receiver, custom status;
• a custom header by name, by value or both;
• text inside the error message;
• text inside attachments, for example an order number. Narrow the time range or the flow first: the content of every candidate attachment is read.

A message opens with everything it had: status, IDs, custom headers, error text, runs and steps, and every attachment, to read or download. Click a correlation ID or a header value to find the related messages.

Status overview and storage usage

• Status overview counts messages per integration flow (or package) and status over a time range, like the Message Status Overview of Cloud Integration, but over everything you have kept.
• Storage usage shows which flows write the most attachment data. Since the tenant database has a size limit, this tells you where to drop attachments or lower the log level.

Retention and disk space

Companion does not delete a stored log unless you asked for it:

• Retention removes whole months once they are older than the retention you set. With “Archive expired periods” and an archive directory, they are moved there instead, and Settings → Storage restores an archived month with one click.
• A storage quota for a tenant removes its oldest months when the tenant exceeds it.
• When the data volume runs full (less than 1 GB free by default), log sync pauses for every tenant and the application shows an alert. Nothing is deleted, and nothing is missed while the tenant still has the logs. Sync continues by itself once there is space. Deleting the oldest months automatically instead is opt-in: COMPANION_EVICT_ON_LOW_DISK.

As a guide for sizing: in our tests a million messages needed about 3.5 GB, attachments included. Tenants with large attachments need more.

Community and enterprise

Log sync runs and stores everything with every license. The community license searches and opens the messages of the last 7 days; the enterprise license opens everything stored and restores archived months. Nothing is dropped when a license ends.

Good to know

• Text filters match exactly, except the error text and the attachment content, which match a part of the text. Both are case-sensitive.
• The package filter uses the package a flow belongs to today, also for old months.
• An attachment search stops after 15 seconds and offers to continue, so a very wide search takes several steps.