Skip to content

Maya Dome Diagnostics Tool

Andrew Hazelden edited this page Jan 6, 2017 · 12 revisions

Introduction

The Dome Diagnostics tool provides a markdown formatted report log that analyses your current Maya session information using a MEL script. It is a powerful tool that can help troubleshoot configuration issues with hardware, networking, mapped network drives, environment variables, Maya scene files, Maya plugins, and 3rd party renderers.

Diagnostics Log in Stackedit

Launching the Diagnostics Tool

After you run the Dome Diagnostics tool a log is saved to your desktop. If you have notepad++ installed on your system, the log file will be opened in a new notepad++ window.

Domemaster3D Shelf Item

The Dome Diagnostics tool can be launched from the Domemaster3D shelf by clicking on the "Diag" shelf icon.

Dome Diag Shelf Tool

Domemaster3D Menu Item

If you switch to the Rendering menu set, you can open the Domemaster3D menu and select the "Create Diagnostics Report" menu item.

Diagnostics Menu Item

Launching domeDiagnostics.mel in MayaBatch

Maya Batch Windows Command Prompt

It is possible to launch the diagnostics tool from the command line using the terminal / command prompt window. This can be handy if you are using SSH or screen sharing to investigate render node issues.

Windows Diagnostics

Here is an example using Maya Batch with the domeDiagnostics() MEL function on Windows:

mayabatch -script "C:\Program Files\Domemaster3D\maya\common\scripts\domeDiagnostics.mel" -command "domeDiagnostics();"

Mac Diagnostics

Here is an example using Maya Batch with the domeDiagnostics() MEL function on Mac OS X. The Mac example assumes you are using the Autodesk Maya provided terminal file "Maya Terminal.term", or you have added the mayabatch program folder to your system path variable using your ~/.bash_profile document.

mayabatch -script "/Applications/Domemaster3D/maya/common/scripts/domeDiagnostics.mel" -command "domeDiagnostics();"

Linux Diagnostics

Here is an example using Maya Batch with the domeDiagnostics() MEL function on Linux. For the example it is expected that the mayabatch program folder is in your system path variable.

maya -batch -script "/opt/Domemaster3D/maya/common/scripts/domeDiagnostics.mel" -command "domeDiagnostics();"

Diagnostics Report

The DomeDiagnostics function creates a dynamically generated report using Maya and MEL scripting with the following Maya specific outputs:

  • Computer Name
  • User Account
  • Hardware
    • Processor Type
    • Number of Processors & Speed
    • Physical Memory
    • Free System Memory
  • Networking
    • Network Adapters
    • IP addresses
    • MAC Addresses
  • Hard Disks
  • Graphics
    • Graphics Card Model
    • Free GPU Memory
    • OpenGL version
  • Active Processes
  • Maya Details
    • Maya Version + Platform
    • Maya Install Location
    • Maya UI Language Format
    • Maya Locale (Codeset) Format
    • Maya Build Version
    • MAYA Network Connection Status
    • MAYA_LICENSE
    • MAYA_LICENSE_METHOD
    • MAYA_DISABLE_IDLE_LICENSE
    • MAYA_ALT_EN
    • Rendering Software Available
    • Active Renderer
    • Current Maya Scene
    • Recent Scenes
    • Current Workspace
    • Recent Workspaces
    • Renderable Cameras
    • Maya Home Folder Path
    • Maya Render Log File Path
    • Maya Scripts Folder List
    • Maya.env File Path
    • Maya.env File Contents
    • userSetup.py File Contents
    • userSetup.mel File Contents
    • MAYA_MODULE_PATH
    • MAYA_SHELF_PATH
    • MAYA_SCRIPT_PATH
    • SHARED_MAYA_DIR
    • PYTHONPATH
    • MAYA_PRESET_PATH
    • XBMLANGPATH
    • MAYA_PLUG_IN_PATH
    • MAYA_QUICKTIME_ENCODING_GAMMA
    • MAYA_RUNNING_TESTS
    • MAYA_NO_CONSOLE_WINDOW
    • MAYA_DISABLE_IDLE_LICENSE
    • MAYA_ADSK_ASSET_LIBS
    • MAYA_BATCH_RENDERING_STOPS_ON_ERROR
    • MAYA_BG_DEPTH_IMAGE
    • MAYA_BIFROST_COMPOUNDS
    • MAYA_COLOR_MANAGEMENT_POLICY_FILE
    • MAYA_COLOR_MANAGEMENT_POLICY_LOCK
    • MAYA_CUSTOM_TEMPLATE_PATH
    • MAYA_DISABLE_LOOKDEV_MATERIAL_VIEWER
    • MAYA_DISABLE_LOOKDEV_PROPERTY_PANEL
    • MAYA_DISABLE_VP2_WHEN_POSSIBLE
    • MAYA_ENABLE_CLASSIC_HAIR
    • MAYA_ENABLE_LEGACY_HYPERSHADE
    • MAYA_ENABLE_LEGACY_PARTICLES
    • MAYA_ENABLE_LEGACY_RIGID
    • MAYA_ENABLE_LEGACY_RENDER_LAYERS
    • MAYA_ENABLE_VP2_SHAPE_INSTANCING
    • MAYA_EXPOSE_FACADE_NODES
    • MAYA_FBX_PLUGIN_LOCATION
    • MAYA_HELP_URL
    • MAYA_NO_INITIAL_AUTOLOAD_MT
    • MAYA_OFFSCREEN_HRB
    • MAYA_OGS_DEVICE_OVERRIDE
    • MAYA_PLUG_IN_RESOURCE_PATH
    • MAYA_PROJECT
    • MAYA_PROJECTS_DIR
    • MAYA_PSEUDOTRANS_MODE
    • MAYA_REAL_WORLD_SIZE
    • MAYA_REVERSE_FILEFORMAT_EXT
    • MAYA_SCRIPT_BASE
    • MAYA_SHADER_LIBRARY_PATH
    • MAYA_TESTING_CLEANUP
    • MAYA_TEXTURED_SCULPT
    • MAYA_UI_LANGUAGE
    • MAYA_VP2_DEVICE_OVERRIDE
    • MAYA_VR_PER_SHAPE_ATTR
    • NEX_DRINIT_PATH
    • ONECLICK_KEEP_TEMP_FILES
    • ONECLICK_SELECT_WHOLE_CHARACTER
    • ONECLICK_TEMP_DIR
    • PYMEL_SKIP_MEL_INIT
    • ALIAS_RENDER_LIB_PATH
    • ENABLE_DEFAULT_VIEWPORT_CAMERA_SETS
    • SUBSTANCES_LOCATION
    • WINEDITOR
    • XPC_SERVICE_NAME
    • Loaded Maya Plugins
    • Image Formats
  • Bifrost Environment Variables
    • BIFROST_ECHO_GEOSHADER
    • BIFROST_ENABLE_GRAPH_EDITING
    • BIFROST_LOCATION
  • QT Support Environment Variables
    • QT_MAC_NO_NATIVE_MENUBAR
    • QT_HIGHDPI_AWARE
    • MAYA_ALIEN_WIDGETS
  • XGEN Environment Variables
    • XGEN_CONFIG_PATH
    • XGEN_EXPORT_ARCHIVE_STANDALONE
    • XGEN_LOCATION
    • XGEN_ROOT
    • HDF5_DISABLE_VERSION_CHECK
  • SEEXPR Software Environment Variables
    • SE_EXPR_PLUGINS
  • Domemaster3D Environment Variables
    • DOMEMASTER3D_MAYA_DIR
    • DOMEMASTER3D_MAYA_TARGET
    • DOMEMASTER3D_MAYA_REALTIME_FOV
    • Dome Diagnostics Script Path
  • OS Environment Variables
    • PATH
    • TEMP
    • USERPROFILE PATH
    • LD_LIBRARY_PATH
  • Mental Ray Environment Variables
    • MI_CUSTOM_SHADER_PATH
    • MI_CUSTOM_SHADER_SUPPRESS
    • MI_MAYA_SOCKETS
    • MI_MAYA_BATCH_OPTIONS
    • MI_LIBRARY_PATH
    • MENTALRAY_LOCATION
    • MENTALRAY_BIN_LOCATION
    • MENTALRAY_SHADERS_LOCATION
    • MENTALRAY_INCLUDE_LOCATION
    • MAYA_EXR_LONGNAME
    • MAYA_MRFM_SHOW_CUSTOM_SHADERS
    • MAYATOMR
    • IMF_PLUG_IN_PATH
    • Mental Ray Include Directory Contents
    • Mental Ray Shader Directory Contents
  • Arnold Environment Variables
    • solidangle_LICENSE
    • ARNOLD_PATH
    • ARNOLD_PLUGIN_PATH
    • MTOA_TEMPLATES_PATH
    • MTOA_EXTENSIONS_PATH
    • MTOA_PATH
    • MTOA_LOG_PATH
    • MTOA_SILENT_MODE
    • MTOA_COMMAND_PORT
    • ARNOLD_LICENSE_ATTEMPTS
    • ARNOLD_LICENSE_ATTEMPT_DELAY
    • K_SEARCH_PATH
  • PlayblastVR Variables and OptionVars
    • PlayblastVR Panorama Format
    • Show Batch Sequence viewer
    • PlayblastVR Module Path
  • Maxwell Environment Variables
    • MAXWELL3_ROOT
    • MAXWELL3_LICENSE_SERVER
    • MAXWELL3_MATERIALS_DATABASE
  • Vray Environment Variables
    • VRAY_PATH
    • VRAY_PLUGINS_x64
    • VRAY_AUTH_CLIENT_FILE_PATH
    • VRAY_FOR_MAYA_DRLISTS_PATH
    • VRAY_FOR_MAYA_DRPORT
    • VRAY_ADVANCED_UI
    • VRAY_FOR_MAYA2010_MAIN_x64
    • VRAY_FOR_MAYA2010_PLUGINS_x64
    • VRAY_TOOLS_MAYA2010_x64
    • VRAY_FOR_MAYA2011_MAIN_x64
    • VRAY_FOR_MAYA2011_PLUGINS_x64
    • VRAY_TOOLS_MAYA2011_x64
    • VRAY_FOR_MAYA2012_SKIP_NODE_CATEGORIZATION
    • VRAY_FOR_MAYA2012_MAIN_x64
    • VRAY_FOR_MAYA2012_PLUGINS_x64
    • VRAY_TOOLS_MAYA2012_x64
    • VRAY_FOR_MAYA2013_MAIN_x64
    • VRAY_FOR_MAYA2013_PLUGINS_x64
    • VRAY_TOOLS_MAYA2013_x64
    • VRAY_FOR_MAYA2014_MAIN_x64
    • VRAY_FOR_MAYA2014_PLUGINS_x64
    • VRAY_FOR_MAYA2014_MAIN_PowerPC
    • VRAY_TOOLS_MAYA2014_x64
    • VRAY_FOR_MAYA2015_MAIN_x64
    • VRAY_FOR_MAYA2015_PLUGINS_x64
    • VRAY_TOOLS_MAYA2015_x64
    • VRAY_FOR_MAYA2016_MAIN_x64
    • VRAY_FOR_MAYA2016_PLUGINS_x64
    • VRAY_TOOLS_MAYA2016_x64
    • VRAY_OSL_PATH_MAYA2016_PowerPC
    • VRAY_OSL_PATH_MAYA2016_x64
    • VRAY_FOR_MAYA2016_5_MAIN_x64
    • VRAY_FOR_MAYA2016_5_PLUGINS_x64
    • VRAY_FOR_MAYA2016_5_MAIN_PowerPC
    • VRAY_FOR_MAYA2016_5_PLUGINS_PowerPC
    • VRAY_TOOLS_MAYA2016_5_x64
  • Fabric Engine Environment Variables
    • FABRIC_CAPI_DIR
    • FABRIC_DIR
    • FABRIC_DOCUMENTATION_DIR
    • FABRIC_EDK_DIR
    • FABRIC_PYTHON_MODULE_DIR
    • FABRIC_TOOLS_DIR
    • FABRIC_EXTS_PATH
    • FABRIC_SPLICE_UNGUARDED
    • FABRIC_CUDA_LOG
  • RLM License Manager Environment Variables
    • HTTP_PROXY
    • RLM_COMM_TIMEOUT
    • RLM_CONNECT_TIMEOUT
    • RLM_DEBUG
    • RLM_DIAGNOSTICS
    • RLM_EXTENDED_ERROR_MESSAGES
    • RLM_LICENSE
    • RLM_NO_UNLIMIT
    • RLM_LICENSE_PASSWORD
    • RLM_PATH_RANDOMIZE
    • RLM_PROJECT
    • RLM_QUEUE
    • RLM_ROAM
    • RLMSTAT

Viewing the Markdown Formatted Log

The diagnostics report is saved automatically to the system's desktop folder with the following naming convention:
Domemaster3D_Report_<Computer Name>_<User Account Name>.md

Using the above naming template, running the analysis report on a computer with the name "HP" and a user account of "hazelden" will create a diagnostics file named:
Domemaster3D_Report_HP_hazelden.md

The diagnostics output is formatted in plain text format using the "markdown" syntax and can be opened in Markdown Pad / StackEdit / Notepad++ / TextWrangler / BBedit / Atom or any other plain text editor. My personal favorite "visual" markdown document editors are Markdown Pad, and Atom and they both are available as free to use programs.

StackEdit

Diagnostics Log in Stackedit

Markdown Pad

Diagnostics Log in Markdown Pad

Notepad++

Diagnostics Log in Notepad++

Clone this wiki locally