跳转至

New Relic For .Net

New Relic 的 .Net Agent 是基于 .Net 技术框架的开源项目，可用于对 .NET 技术框架的 App 进行全面的性能观测。也可以用于所有兼容 .NET 技术框架的语言例如：C#, VB.NET, CLI。

配置

采集器配置

进入 DataKit 安装目录下的 conf.d/newrelic 目录，复制 newrelic.conf.sample 并命名为 newrelic.conf。示例如下：

[[inputs.newrelic]]
  ## NewRelic Agent endpoints registered address endpoints for HTTP.
  ## DO NOT EDIT
  endpoints = ["/agent_listener/invoke_raw_method"]

  ## Keep rare tracing resources list switch.
  ## If some resources are rare enough(not presend in 1 hour), those resource will always send
  ## to data center and do not consider samplers and filters.
  # keep_rare_resource = false

  ## Ignore tracing resources map like service:[resources...].
  ## The service name is the full service name in current application.
  ## The resource list is regular expressions uses to block resource names.
  ## If you want to block some resources universally under all services, you can set the
  ## service name as "*". Note: double quotes "" cannot be omitted.
  # [inputs.newrelic.close_resource]
    # service1 = ["resource1", "resource2", ...]
    # service2 = ["resource1", "resource2", ...]
    # "*" = ["close_resource_under_all_services"]
    # ...

  ## Sampler config uses to set global sampling strategy.
  ## sampling_rate used to set global sampling rate.
  # [inputs.newrelic.sampler]
    # sampling_rate = 1.0

  # [inputs.newrelic.tags]
    # key1 = "value1"
    # key2 = "value2"
    # ...

  ## Threads config controls how many goroutines an agent cloud start to handle HTTP request.
  ## buffer is the size of jobs' buffering of worker channel.
  ## threads is the total number fo goroutines at running time.
  # [inputs.newrelic.threads]
    # buffer = 100
    # threads = 8

  ## Storage config a local storage space in hard dirver to cache trace data.
  ## path is the local file path used to cache data.
  ## capacity is total space size(MB) used to store data.
  # [inputs.newrelic.storage]
    # path = "./newrelic_storage"
    # capacity = 5120

配置好后，重启 DataKit 即可。

目前可以通过 ConfigMap 方式注入采集器配置来开启采集器。

完成配置后重启 Datakit 和 IIS

PS> datakit service -R
PS> iisreset

前置条件

  • 域名准备及证书生成与安装
  • 注册 New Relic 账号
  • 安装 New Relic Agent 当前支持版本为 6.27.0
  • 安装 .Net Framework 当前支持版本为 3.0

安装并配置 New Relic .NET Agent

首先确认当前 Windows OS 安装的 DotNet Framework 版本，运行 cmd 输入 reg query "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP" 查看当前 OS 上安装的所有版本。

然后进行 New Relic Agent 的安装：

进入账号后，单击左侧目录栏下的创建数据 + Add Data 子目录，后在右侧的 Data source 子目录里的 Application monitoring 中选择 .Net 后安装指引进行安装。

  • 也可以通过安装程序进行安装：

打开下载目录 下载 dotnet agent 版本 6.27.0 选择对应的安装程序。

配置 New Relic Agent

  • 配置必要的环境变量

右键单击桌面左下角 Windows 徽标选择 系统，选择 高级系统设置，选择 环境变量 ，查看 系统变量 列表是否包含一下环境变量配置：

- `COR_ENABLE_PROFILING`: 数字值 1 默认开启
- `COR_PROFILER`: 字符值，默认为系统自动填写的 `ID`
- `CORECLR_ENABLE_PROFILING`: 数字值 1 默认开启
- `NEW_RELIC_APP_NAME`: 字符值，填写被观测的 `APP` 名字 （可选）
- `NEWRELIC_INSTALL_PATH`: `New Relic Agent` 安装路径
  • 通过配置文件配置 New Relic

打开 New Relic Agent 安装目录下的 newrelic.config 将以下示例中 {示例值} 替换为真实值，其他值按照示例中对照填写

<?xml version="1.0"?>
<!-- Copyright (c) 2008-2017 New Relic, Inc.  All rights reserved. -->
<!-- For more information see: https://newrelic.com/docs/dotnet/dotnet-agent-configuration -->
<configuration xmlns="urn:newrelic-config" agentEnabled="true" agentRunID="{agent id (可自己制定也可不填)}">
  <service licenseKey="{真实的 license key}" ssl="true" host="{www.your-domain-name.com}" port="{Datakit 端口号}" />
  <application>
    <name>{被检测的 APP 名字}</name>
  </application>
  <log level="debug" />
  <transactionTracer enabled="true" transactionThreshold="apdex_f" stackTraceThreshold="500" recordSql="obfuscated" explainEnabled="false" explainThreshold="500" />
  <crossApplicationTracer enabled="true" />
  <errorCollector enabled="true">
    <ignoreErrors>
      <exception>System.IO.FileNotFoundException</exception>
      <exception>System.Threading.ThreadAbortException</exception>
    </ignoreErrors>
    <ignoreStatusCodes>
      <code>401</code>
      <code>404</code>
    </ignoreStatusCodes>
  </errorCollector>
  <browserMonitoring autoInstrument="true" />
  <threadProfiling>
    <ignoreMethod>System.Threading.WaitHandle:InternalWaitOne</ignoreMethod>
    <ignoreMethod>System.Threading.WaitHandle:WaitAny</ignoreMethod>
  </threadProfiling>
</configuration>

配置主机

由于 New Relic Agent 需要配置 HTTPS 完成数据传输所以进行主机配置前首先完成证书的申请，由于 New Relic Agent 启动过程中需要完成证书合法性验证，这里需要完成 CA 的自签和自签 CA 的证书签发。完成证书认证链的签发后参考观测云接入 NewRelic .NET 探针和Windows 服务器如何导入根证书和中间证书？进行证书的部署。

完成证书部署后需要对 hosts 文件进行相应的配置已满足本地解析域名的能力 hosts 配置如下：

127.0.0.1    www.your-domain-name.com

其中 www.your-domain-name.com 为 newrelic.config 配置文件中 service.host 项中制定的域名

指标

以下所有数据采集，默认会追加名为 host 的全局 tag（tag 值为 DataKit 所在主机名），也可以在配置中通过 [inputs.newrelic.tags] 指定其它标签：

[inputs.newrelic.tags]
 # some_tag = "some_value"
 # more_tag = "some_other_value"
 # ...

newrelic

  • 标签
Tag Description
container_host Container hostname. Available in OpenTelemetry. Optional.
endpoint Endpoint info. Available in SkyWalking, Zipkin. Optional.
env Application environment info. Available in Jaeger. Optional.
host Hostname.
http_method HTTP request method name. Available in DDTrace, OpenTelemetry. Optional.
http_route HTTP route. Optional.
http_status_code HTTP response code. Available in DDTrace, OpenTelemetry. Optional.
http_url HTTP URL. Optional.
operation Span name
project Project name. Available in Jaeger. Optional.
service Service name. Optional.
source_type Tracing source type
span_type Span type
status Span status
version Application version info. Available in Jaeger. Optional.
  • 指标列表
Metric Description Type Unit
duration Duration of span int μs
message Origin content of span string -
parent_id Parent span ID of current span string -
resource Resource name produce current span string -
span_id Span id string -
start start time of span. int usec
trace_id Trace id string -

FAQ

New Relic license key 在哪里？

如果是从 New Relic 官网指引安装，license key 将自动完成填写，如果是自行手动安装 license key 将在安装程序运行过程中要求填写，license key 在创建账号或者创建数据时会出现建议保存。

TLS 版本不兼容

部署 New Relic Agent 过程中如果遇到没有数据上报，并且在 New Relic 日志中看到类似以下 ERROR 信息：

NewRelic ERROR: Unable to connect to the New Relic service at collector.newrelic.com:443 : System.Net.WebException:
The request was aborted: Could not create SSL/TLS secure channel.
...
NewRelic ERROR: Unable to connect to the New Relic service at collector.newrelic.com:443 : System.Net.WebException:
The underlying connection was closed: An unexpected error occurred on a send. ---> System.IO.IOException:
Received an unexpected EOF or 0 bytes from the transport stream.
...
NewRelic ERROR: Unable to connect to the New Relic service at collector.newrelic.com:443 : System.Net.WebException:
The underlying connection was closed: An unexpected error occurred on a receive. ---> System.ComponentModel.Win32Exception:
The client and server cannot communicate, because they do not possess a common algorithm.

请参考文档No data appears after disabling TLS 1.0排查问题

参考资料

文档评价

文档内容是否对您有帮助？ ×