Metalama 1.0 / / Metalama Documentation / Conceptual Documentation / Troubleshooting / Enabling logging

Enabling logging

If you report a Metalama bug, you may be asked to send Metalama logs. Here is how to produce them.

Step 1. Install metalama-config

Install metalama .NET tool as described in Installing Metalama Command Line Tools.

Step 2. Edit diagnostics.json

Execute the command:

            metalama config edit diagnostics.

          

This should open a diagnostics.json file in your default editor. Edit this file as follows:

  1. In the logging/processes section, set to true the processes for which logging should be enabled:
    • Compiler: the compile-time process.
    • Rider: the design-time Roslyn process running under Rider.
    • DevEnv: the UI process of Visual Studio (note that there is no aspect code running in this process).
    • RoslynCodeAnalysisService: the design-time Roslyn process running under Visual Studio (this is where the aspect code runs).
  2. In the logging/trace section, set to true the categories for which logging should be enabled. To enable logging for everything, enable the * category.

In the next example, logging is enabled for the compiler process for all categories.

            {
    "logging": {
        "processes": {
                "Other": false,
                "Compiler": true,
                "DevEnv": false,
                "RoslynCodeAnalysisService": false,
                "Rider": false,
                "BackstageWorker": false,
                "MetalamaConfig": false,
                "TestHost": false
      },
    "trace": {
        "*": false
      },
    "stopLoggingAfterHours": 5.0
  }
}

          

To verify that the JSON file is correct, you can run:

            metalama config verify diagnostics

          

Step 3. Restart processes

Diagnostic settings are cached in all processes, including background compiler processes and IDE helper processes.

To restart background compiler processes, do:

            metalama kill

          

To restart IDE processes, if you want to change logging of the IDE processes, restart your IDE manually.

Step 4. Execute Metalama

Execute the sequence of actions to be logged.

Warning

Logging is automatically disabled after specified amount of hours since the last modification of diagnostics.json. The time value is taken from stopLoggingAfterHours property set in logging section and defaults to 2 hours. You can edit the diagnostics.json to change the value.

Step 5. Open the log file

You will find the log under the %TEMP%\Metalama\Logs directory.