Skip to main content
Use sdk.log to emit general-purpose informational messages from your agent. This is the baseline log level — suitable for tracing execution flow, recording inputs, or marking the start of a processing step. The dashboard terminal displays these messages at the info level without a color highlight.

Parameters

message
string
required
The log message to display in the dashboard terminal.
metadata
object
Optional key-value data attached to the log entry. The dashboard parses and displays this object as formatted JSON, making it easy to inspect structured values like symbols, timestamps, or configuration.

Example

sdk.log("Scanning market data...", { symbol: "BNB", interval: "1h" });

Dashboard output

Every call to sdk.log writes a line to stdout in the following format:
[DOLPHIN_SDK] {"type":"info","message":"Scanning market data...","metadata":{"symbol":"BNB","interval":"1h"},"timestamp":"2024-01-01T00:00:00.000Z"}
The [DOLPHIN_SDK] prefix allows the platform to identify and parse SDK output from other stdout lines. The dashboard terminal renders info-level entries without a color highlight, distinguishing them visually from success, warn, and error entries.

Payload structure

The internal payload sent for every sdk.log call:
{
  "type": "info",
  "message": "<your message>",
  "metadata": {},
  "timestamp": "<ISO 8601 timestamp>"
}
If you omit the metadata argument, the payload includes an empty object ({}).