[isaacsim.common] Isaac Sim Common Libraries#
Version: 6.2.0
Overview#
The isaacsim.common extension packages the common modules for Kit and connects logging and profiling to the
application’s Carbonite services. Callers use the same isaacsim.common.logging and isaacsim.common.profiling APIs
inside and outside Kit.
Functionality#
The native adapter makes isaacsim.common.logging borrow Kit’s existing Carbonite logging interface. It does not
acquire, release, or configure Kit’s Carbonite framework, so the Kit application continues to own process-wide
logging settings.
Logger construction only caches channel state. It does not initialize the standalone backend, so feature modules may construct loggers before this extension starts. The adapter registers those existing channels when it attaches Kit’s logging interface.
Extensions that depend on isaacsim.common can use the logging API:
from isaacsim.common.logging import Logger
logger = Logger("isaacsim.example.feature")
logger.info("The feature started")
logger.warning("The fallback path was selected", capture_source=True)
Python source capture is disabled by default. Pass capture_source=True to an individual logging call when its
filename, function, and line should be forwarded to the application logging system.
Runtime libraries can add profiling zones without depending on Kit or a specific profiler. The extension attaches
isaacsim.common.profiling to Kit’s Carbonite profiler for its lifetime. Profiling calls are no-ops when the
application profiler does not admit them.
Enable Extension#
The extension can be enabled (if not already) in one of the following ways:
Define the next entry as an application argument from a terminal.
APP_SCRIPT.(sh|bat) --enable isaacsim.common
Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.
[dependencies]
"isaacsim.common" = {}
Open the Window > Extensions menu in a running application instance and search for isaacsim.common.
Then, toggle the enable control button if it is not already active.
Isaac Sim Common extension API#
The extension provides isaacsim.common.logging and isaacsim.common.profiling to dependent extensions.
Use isaacsim.common.logging.Logger for application logging and
isaacsim.common.profiling.zone() for profiler-visible regions of work.