How to: Use the activity log

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

VSPackages can write messages to the activity log. This feature is especially useful for debugging VSPackages in retail environments.

Tip

The activity log is always turned on. Visual Studio keeps a rolling buffer of the last 100 entries as well as the first 10 entries, which have general configuration information.

To write an entry to the activity log

  1. Insert this code in the Initialize method or in any other method except the VSPackage constructor:

    IVsActivityLog log = GetService(typeof(SVsActivityLog)) as IVsActivityLog;
if (log == null) return;

int hr = log.LogEntry((UInt32)__ACTIVITYLOG_ENTRYTYPE.ALE_INFORMATION,
    this.ToString(),
    string.Format(CultureInfo.CurrentCulture,
    "Called for: {0}", this.ToString()));

    This code gets the SVsActivityLog service and casts it to an IVsActivityLog interface. LogEntry writes an informational entry into the activity log using the current cultural context.

  2. When the VSPackage is loaded (usually when a command is invoked or a window is opened), the text is written to the activity log.

To examine the activity log

  1. Run Visual Studio with the /Log command line switch to write ActivityLog.xml to disk during your session.

  2. After closing Visual Studio, find the activity log in the subfolder for Visual Studio data:

    %AppData%\Microsoft\VisualStudio\<version>\ActivityLog.xml.

  3. Open the activity log with any text editor. Here is a typical entry:

    Called for: Company.MyApp.MyAppPackage ...

Robust programming

Because the activity log is a service, the activity log is unavailable in the VSPackage constructor.

You should obtain the activity log just before writing to it. Do not cache or save the activity log for future use.

See also