New Relic

New Relic's .Net Agent is an open source project based on the .Net technology framework, which can be used to conduct comprehensive performance observations of apps based on the .NET technology framework. It can also be used for all languages compatible with the .NET technology framework such as: C#, VB.NET, CLI.

Configuration¶

Collector Config¶

Host InstallationKubernetes

Enter the conf.d/newrelic directory under the DataKit installation directory, copy newrelic.conf.sample and name it newrelic.conf. Examples are as follows:

[[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

After configuration, Restart DataKit.

Currently, the collector can be enabled through ConfigMap method to inject collector configuration.

After completing the configuration, restart Datakit and IIS

PS> datakit service -R
PS> iisreset

Preconditions¶

Domain name preparation and certificate generation and installation
Sign up for a New Relic account
Install New Relic Agent. The current supported version is 6.27.0
Install .Net Framework. The current supported version is 3.0

Install and configure New Relic .NET Agent¶

First confirm the DotNet Framework version currently installed on Windows OS, run cmd and enter reg query "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP" to view all versions installed on the current OS.

Then install New Relic Agent:

You can log in to your personal New Relic account to install:

After entering the account, click the Create Data + Add Data subdirectory under the directory column on the left, and then select .Net in the Application monitoring in the Data source subdirectory on the right and follow the installation guide to install it. .

It can also be installed via the installer:

Open download directory to download dotnet agent version 6.27.0 and select the corresponding installation program.

Configure New Relic Agent

Configure necessary environment variables

Right-click the Windows logo in the lower left corner of the desktop, select System, select Advanced System Settings, select Environment Variables, and check whether the System Variables list contains the following environment variable configuration:

- `COR_ENABLE_PROFILING`: Numeric value 1 enables by default
- `COR_PROFILER`: character value, the default is `ID` automatically filled in by the system
- `CORECLR_ENABLE_PROFILING`: Numeric value 1 enables by default
- `NEW_RELIC_APP_NAME`: character value, fill in the name of the observed `APP` (optional)
- `NEWRELIC_INSTALL_PATH`: `New Relic Agent` installation path

Configure New Relic through configuration file

Open newrelic.config in the New Relic Agent installation directory. Replace {example value} in the following example with the real value, and fill in other values according to the examples.

<?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 (You can make your own or leave it blank)}">
  <service licenseKey="{license key}" ssl="true" host="{www.your-domain-name.com}" port="{DataKit Port}" />
  <application>
    <name>{Detected APP name}</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>

Configure host¶

Since New Relic Agent needs to configure HTTPS to complete data transmission, first complete the [certificate application] (certificate.md#self-signed-certificate-with-openssl) before configuring the host. Due to the New Relic Agent startup process The certificate validity verification needs to be completed. Here, the self-signing of CA and the issuance of the self-signed CA certificate need to be completed. After completing the issuance of the certificate authentication chain, refer to GuanceCloud Access NewRelic .NET Probe and Windows Server How to import root and intermediate certificates? to deploy the certificate.

After completing the certificate deployment, you need to configure the hosts file accordingly to meet the local ability to resolve domain names. The hosts configuration is as follows:

127.0.0.1    www.your-domain-name.com

Where www.your-domain-name.com is the domain name specified in the service.host item in the newrelic.config configuration file

Metric¶

All the following data collection will add a global tag named host by default (the tag value is the host name of DataKit). You can also specify other tags through [inputs.newrelic.tags] in the configuration:

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

`newrelic`¶

tags

Tag	Description
`container_host`	Container hostname. Available in OpenTelemetry. Optional.
`dk_fingerprint`	DataKit fingerprint is DataKit hostname
`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.

fields

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¶

Where is the New Relic license key?¶

If you install from the New Relic official website, the license key will be filled in automatically. If you install it manually, you will be asked to fill in the license key during the installation process. The license key is in Create Account or create data, a suggestion to save will appear.

TLS version incompatible¶

During the deployment of New Relic Agent, if no data is reported, and an ERROR message similar to the following is seen in the New Relic log:

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.

Please refer to the documentationNo data appears after disabling TLS 1.0 to troubleshoot the issue

New Relic

Configuration¶

Collector Config¶

Preconditions¶

Install and configure New Relic .NET Agent¶

Configure host¶

Metric¶

`newrelic`¶

FAQ¶

Where is the New Relic license key?¶

TLS version incompatible¶

References¶

Is this page helpful? ×

New Relic

Configuration¶

Collector Config¶

Preconditions¶

Install and configure New Relic .NET Agent¶

Configure host¶

Metric¶

newrelic¶

FAQ¶

Where is the New Relic license key?¶

TLS version incompatible¶

References¶

Is this page helpful? ×

`newrelic`¶