Skip to main content
Use sdk.success when your agent completes a meaningful operation — a successful trade signal, a completed analysis, or any step that represents a positive outcome. Success entries render in green in the dashboard terminal, giving you an immediate visual confirmation that the key moments in your agent’s execution went as expected.

​
Parameters

​
message
string
required
A short description of the milestone or successful operation.
​
metadata
object
Optional key-value data attached to the log entry. Pass relevant output values here — prices, signals, identifiers — so the dashboard can display them as formatted JSON alongside the message.

​
Example

sdk.success("Arbitrage opportunity found!", {
  profit: "0.05 ETH",
  pair: "WETH/USDC"
});

​
When to use

Call sdk.success for:
  • Completed processing steps that produce a result
  • Successful external API calls or data fetches
  • Positive trade signals or analysis conclusions
  • Any milestone that confirms the agent is progressing correctly
Reserve sdk.success for genuinely meaningful events. Using it for routine steps dilutes its signal value in the dashboard.

​
Dashboard rendering

sdk.success entries render in green in the Dolphinclaw dashboard terminal. This makes them immediately distinguishable from neutral info logs and from warn and error entries.