Retrieve simulator logs

async AsyncCogniteClient.simulators.logs.retrieve(

ids: int | Sequence[int],

) → SimulatorLogList | SimulatorLog | None

Retrieve simulator logs

Simulator logs track what happens during simulation runs, model parsing, and generic connector logic. They provide valuable information for monitoring, debugging, and auditing.

Simulator logs capture important events, messages, and exceptions that occur during the execution of simulations, model parsing, and connector operations. They help users identify issues, diagnose problems, and gain insights into the behavior of the simulator integrations.

Parameters:

ids (int | Sequence[int]) – The ids of the simulator log.

Returns:

Requested simulator log(s)

Return type:

SimulatorLogList | SimulatorLog | None

Examples

Get simulator logs by simulator model id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> model = client.simulators.models.retrieve(ids=1)
>>> logs = client.simulators.logs.retrieve(ids=model.log_id)

Get simulator logs by simulator integration id:

>>> integrations = client.simulators.integrations.list()
>>> logs = client.simulators.logs.retrieve(ids=integrations[0].log_id)

Get simulator logs by simulation run id:

>>> run = client.simulators.runs.retrieve(ids=1)
>>> logs = client.simulators.logs.retrieve(ids=run.log_id)

Get simulator logs directly on a simulation run object:

>>> run = client.simulators.runs.retrieve(ids=2)
>>> res = run.get_logs()