Docs 菜单

Docs 主页 → MongoDB Analyzer

配置 MongoDB Analyzer

在此页面上

  • 概述
  • 配置
  • 选项
  • 遥测

概述

了解如何在 .NET 项目中配置 MongoDB Analyzer 以及哪些配置选项可用。

配置

要配置 MongoDB Analyzer，请执行以下操作：

  1. 按照安装指南中的说明安装 MongoDB Analyzer。

  2. 创建一个名为mongodb.analyzer.json的文件，指定 MongoDB Analyzer 的配置。

    重要

    命名

    您必须将配置文件命名为mongodb.analyzer.json 。

  3. 将配置添加到mongodb.analyzer.json文件中。

    以下示例配置使 MongoDB Analyzer 使用 LINQ3提供商。

    { "DefaultLinqVersion": "V3" }

  4. 将以下内容添加到 .NET 应用程序的.csproj文件的Project标签内：

    <ItemGroup>
      <AdditionalFiles Include="<path to your mongodb.analyzer.json file>" />
    </ItemGroup>

注意

可选配置

如果不指定配置文件，MongoDB Analyzer 将使用所有配置选项的默认值。

要了解有关 .NET 项目文件的更多信息，请参阅 Understand the Project File 来自 Microsoft。

要了解有关AdditionalFiles 标签的详情，请参阅 使用其他文件 在 Roslyn 文档中。

选项

以下是 MongoDB Analyzer 支持的所有配置选项的说明：

名称
说明
DefaultLinqVersion
类型：字符串

说明： MongoDB Analyzer 使用的 LINQ 提供商。

提示

要了解有关 LINQ 的更多信息，请参阅分析代码页面。

接受值："V2" 或 "V3"
默认："V2"。
EnableVariableTracking
类型：布尔值

说明：指定 MongoDB Analyzer 是否追踪和组合构建器表达式变量。

提示

要了解有关表达式构建器的更多信息，请参阅分析代码页面。

接受值：true 或 false
默认：true。
日志文件名
类型：字符串

说明：指定 MongoDB Analyzer 写入内部日志的路径。

重要

要输出日志，必须同时指定日志文件和OutputInternalLogsToFile选项。

使用以下示例配置使 MongoDB Analyzer 将信息输出到日志文件：

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"
接受的值：有效的文件路径
默认：""。
OutputDriverVersion
类型：布尔值

说明：指定 MongoDB Analyzer 是否在诊断消息中包含 .NET/C# 驱动程序版本。

接受值：true 或 false
默认：false。
OutputInternalExceptions
类型：布尔值

说明：指定 MongoDB Analyzer 是否在诊断消息中包含内部异常。

接受值：true 或 false
默认：false。
OutputInternalLogsToFile
类型：布尔值

说明：指定 MongoDB Analyzer 是否将其内部日志写入文件。

重要

要输出日志，必须同时指定日志文件和OutputInternalLogsToFile选项。

使用以下示例配置使 MongoDB Analyzer 将信息输出到日志文件：

"OutputInternalLogsToFile": true,
"LogFileName": "<path to your logfile>"
接受值：true 或 false
默认：false。
PocoAnalysisVerbosity
类型：字符串

说明：指定 MongoDB Analyzer 将哪些 POCO 预览为 JSON。您可以将此选项设置为以下值之一：

  • "All"：预览所有 POCO

  • "Medium"：仅预览属于 LINQ 或构建器表达式的一部分或具有 BSON 属性的 POCO

  • "None"：不预览 POCO

接受值： "All" 、 "Medium"或"None"
默认："Medium"。
SendTelemetry
类型：布尔值

说明：指定 MongoDB Analyzer 是否会收集匿名信息并将其发送给 MongoDB Inc. 以改进产品。

提示

要了解有关 MongoDB Analyzer 中遥测的更多信息，请参阅本指南的遥测部分。

接受值：true 或 false
默认：true。

要了解有关 MongoDB Analyzer 支持的配置选项的更多信息，请参阅 MongoDB Analyzer 源代码。

遥测

当 MongoDB Analyzer 分析源代码时，该工具默认会收集匿名信息并将其发送给 MongoDB Inc. 以改进产品。

要禁用此功能，请在配置文件中指定以下选项：

"SendTelemetry": false

要查看启用遥测后 MongoDB Analyzer 收集的所有信息的完整列表，请参阅常见问题解答页面。

要详细了解 MongoDB Inc. 如何使用收集的数据，请参阅隐私政策。

←  规则和消息内容已知问题 →

在此页面上