从Visual Studio 2013升级至2022的解决方案无法设置遥测环境变量，如何解决？

问题 #

将包含C++ Libraries的Visual Studio 2013解决方案升级到Visual Studio 2022后，其他环节正常，但触发如下构建错误：

Error   MSB4044 The "SetEnv" task was not given a value for the required parameter "Value". testproject C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Microsoft\VC\v170\Microsoft.Cpp.DesignTime.targets  550

经排查，原因是VSTEL_SolutionSessionID、VSTEL_CurrentSolutionBuildID和ProjectGuid三个变量未被设置。新建测试控制台解决方案中这些变量自动存在，但在项目或解决方案文件中找不到明确定义，它们属于Visual Studio遥测相关变量。

临时将这些变量在系统环境变量中设为-1后，升级项目可完成构建，但不清楚根因，需明确：

1. 这些变量正常情况下的设置机制是什么？
2. 应如何正确配置？

错误触发自以下Microsoft.Cpp.DesignTime.targets文件片段：

<Target Name="SetTelemetryEnvironmentVariables"
        Condition="'$(DesignTimeBuild)' != 'true'">

  <SetEnv Name   ="VSTEL_SolutionSessionID"
          Value  ="$(VSTEL_SolutionSessionID)"
          Prefix ="false">
  </SetEnv>
  <SetEnv Name   ="VSTEL_CurrentSolutionBuildID"
          Value  ="$(VSTEL_CurrentSolutionBuildID)"
          Prefix ="false">
  </SetEnv>
  <SetEnv Name   ="VSTEL_ProjectID"
          Value  ="$(ProjectGuid)"
          Prefix ="false">
    <Output TaskParameter="OutputEnvironmentVariable" PropertyName="VSTEL_ProjectID"/>
  </SetEnv>
</Target>

分析与解决方案 #

一、变量的正常设置机制 #

• VSTEL_SolutionSessionID与VSTEL_CurrentSolutionBuildID：这两个是Visual Studio IDE启动构建流程时自动注入的临时遥测变量，用于标识当前解决方案会话、构建任务的唯一ID，不属于项目/解决方案文件的固定配置，无需手动定义。它们仅用于微软收集构建相关遥测数据，不影响核心构建逻辑。
• ProjectGuid：这是每个VC++项目的内置属性，正常情况下会自动从项目文件（.vcxproj）的<ProjectGuid>节点读取。该变量缺失，大概率是升级过程中项目文件的对应节点被意外移除，或MSBuild加载项目时未能正确解析该属性。

二、正确配置方法 #

1. 修复ProjectGuid缺失问题
   • 打开升级后的.vcxproj文件，检查是否存在<ProjectGuid>{项目唯一GUID}</ProjectGuid>节点，通常位于文件开头的<PropertyGroup Label="Globals">区块内。
   • 若缺失，可从原VS2013项目文件中复制对应GUID，或通过VS工具菜单→创建GUID→选择格式4（去掉大括号）生成新GUID后添加。
2. 解决遥测变量注入问题
   • 若IDE未自动注入VSTEL_*系列变量，多为构建触发方式问题：
     • 确保从Visual Studio IDE内部启动构建（而非外部MSBuild命令行直接构建，除非手动注入变量）。
     • 尝试重置VS的MSBuild缓存：删除%LOCALAPPDATA%\Microsoft\MSBuild\v17.0（对应VS2022）下的缓存文件，重启VS后重新加载项目。
   • 若必须使用命令行构建，可在启动MSBuild时手动传递变量：

     msbuild YourSolution.sln /p:VSTEL_SolutionSessionID=-1 /p:VSTEL_CurrentSolutionBuildID=-1
     

3. 清理临时系统环境变量
   不建议将这些遥测变量设为系统环境变量，会影响所有VS项目的构建流程。修复上述问题后，应删除之前添加的系统环境变量，恢复默认构建逻辑。

内容的提问来源于stack exchange，提问作者Steve