This feature is available as an add-on for the Honeycomb Enterprise plan.
Please contact your Honeycomb account team for details.
log command. This receiver supports both live system logs and archived log files (.logarchive).
Supported Platforms
Available in the Bindplane Distro for OpenTelemetry Collector
v1.87.0+ .
Prerequisites
- macOS 10.12 (Sierra) or later.
- The
logcommand must be available in PATH. - For archive mode: Read access to the
.logarchivedirectory. - For stream mode: Appropriate permissions to read system logs.
Configuration Table
Output Format
The receiver converts macOS logs to OpenTelemetry log records:- Body: Contains the entire log line as a string
- Attributes: Not set
Format Options
ndjson and json formats
When using JSON formats, each log line is captured as a complete JSON string in the body, with timestamp and severity extracted:
- Timestamp: Parsed from the
timestampfield in the JSON - Severity: Mapped from
messageType(Error, Fault, Default, Info, Debug)
default, syslog, and compact formats
When using plain text formats, each log line is captured as plain text in the body:
- Timestamp: Set to observed time (when the log was received)
- Severity: Not set
Security Note
Since the source passes values to the built-inlog command on the agent, there are security risks in using this source if malicious code is passed in by a user. The source uses the following validation to mitigate these risks:
- The following predicate values are not allowed:
- Command separators:
; - Pipes:
| - Variable expansion:
$ - Backticks:
` - Redirects:
>>,<< - Control characters: newlines, carriage returns
- Command separators:
- Valid predicate operators like
&&(logical AND),<,>(comparison) are allowed.- The
>operator is allowed for comparisons (e.g., processID > 100) but blocked when followed by file paths. - The
&&operator is automatically normalized toANDto prevent command chaining. - The
||operator is normalized toORto prevent piping.
- The
- Archive file paths are sanitized and validated.