Skip to main content

1E SDK

Agent.Log

Method

Log

Module

Agent

Library

Core

Action

Write a message to the Tachyon Agent log file.

Parameters

Level (string; optional, default info): The log level at which to write the message; one of: trace, debug, info, warn or error. These values are not case-sensitive.

Message (string): The message to write to the log. Messages longer than 1024 characters will be truncated.

Return values

Level (string): The log level at which the message was written (as per Level parameter).

Message(string): The message written to the log (as per the Message parameter).

Example

Agent.Log(Level: "info", Message: "Starting file analysis");
 
// etc.
 
Agent.Log(Level: "info", Message: "Completed file analysis");

Platforms

  • Windows

  • Linux

  • MacOS

Notes

Useful for diagnosing/monitoring progress of an instruction.

The Agent's log level setting determines whether the specified message actually appears in the log. For example, if the Agent's log level is configured as "info", then "debug" messages will not be visible in the log (but the output of the method will still return the Level and Message values).

In this section: