Skip to content

Commit

Permalink
Merge pull request #18728 from newrelic/fixing-links-in-compatibility…
Browse files Browse the repository at this point in the history 
…-req-doc

fix(.NET): fixing links in compatibility doc
  • Loading branch information
@jeff-colucci
jeff-colucci authored Sep 23, 2024
2 parents a19612a + 4807c12 commit 50ee245
Showing 1 changed file with 47 additions and 40 deletions.
87 changes: 47 additions & 40 deletions ...s/apm/agents/net-agent/getting-started/net-agent-compatibility-requirements.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Tabs>
<TabsBar>
<TabsBarItem id="1">
<TabsBarItem id="core">
.NET Core
</TabsBarItem>
<TabsBarItem id="2">
<TabsBarItem id="framework">
.NET Framework
</TabsBarItem>
</TabsBar>


<TabsPages>
<TabsPageItem id="1">
<TabsPageItem id="core">
## Requirements [#requirements]

Before you install the New Relic .NET agent on Windows or Linux, make sure your system meets these requirements:
Expand Down Expand Up @@ -121,7 +121,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="app-web-servers"
id="app-web-servers-core"
title="App/web servers"
>
Ensure you use one of these app/web servers:
Expand All @@ -135,30 +135,31 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
</Collapser>

<Collapser
id="aws-elastic-beanstalk"
id="aws-elastic-beanstalk-core"
title="AWS Elastic Beanstalk"
>
For [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk) installation instructions, see the [.NET installation guide](/install/dotnet/).
</Collapser>


<Collapser
id="azure"
id="azure-core"
title="Microsoft Azure"
>
For Azure-specific installation instructions, see the [.NET installation guide](/install/dotnet/).
</Collapser>

<Collapser
className="freq-link"
id="net-requirements-core"
title="Network requirements"
>
The agent requires your firewall to allow outgoing connections to specific [networks and ports](/docs/apm/new-relic-apm/getting-started/networks).
</Collapser>

<Collapser
className="freq-link"
id="operating-system"
id="operating-system-core"
title="Operating system"
>
The agent has been verified to work with the following operating systems:
Expand Down Expand Up @@ -221,7 +222,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="user-rights"
id="user-rights-core"
title="Permissions"
>
Installing and running the .NET agent requires these permissions:
Expand Down Expand Up @@ -280,15 +281,15 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="security-requirements"
id="security-requirements-core"
title="Security requirements"
>
As a standard [security measure for data collection](/docs/accounts-partnerships/accounts/security/data-security), your app server must support SHA-2 (256-bit). SHA-1 is not supported.
</Collapser>

<Collapser
className="freq-link"
id="target-framework"
id="target-framework-core"
title="Target framework version"
>
The .NET agent only supports applications targeting .NET Core 3.1, and .NET 5.0, 6.0, and 8.0. You can find the target framework in your `.csproj` file. Agent compatibility varies across different versions of .NET Core.
Expand Down Expand Up @@ -348,7 +349,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="database"
id="database-core"
title="Datastores"
>
The .NET agent automatically instruments the performance of .NET application calls to these datastores:
Expand Down Expand Up @@ -572,7 +573,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="additional-frameworks"
id="additional-frameworks-core"
title="External call libraries"
>
The .NET agent automatically instruments these external call libraries :
Expand Down Expand Up @@ -663,7 +664,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="logging-frameworks"
id="logging-frameworks-core"
title="Logging frameworks"
>
The .NET agent [can be configured](/docs/apm/agents/net-agent/configuration/net-agent-configuration/#application_logging) to automatically instrument these logging frameworks for automatic logs-in-context with [agent forwarding](/docs/logs/logs-context/net-configure-logs-context-all#1-agent) and [local log decoration](/docs/logs/logs-context/net-configure-logs-context-all#2-decorate):
Expand Down Expand Up @@ -756,7 +757,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="messaging"
id="messaging-core"
title="Messaging"
>
The agent automatically instruments these message systems:
Expand Down Expand Up @@ -867,15 +868,15 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

</CollapserGroup>

## Unavailable features [#unavailable]
## Unavailable features [#unavailable-core]

The following features are not available for the .NET agent:

* The .NET agent does not support [trim self-contained deployments and executables](https://docs.microsoft.com/en-us/dotnet/core/deploying/trim-self-contained), because the compiler can potentially trim assemblies that the agent depends on.
* [Infinite Tracing](/docs/distributed-tracing/infinite-tracing/introduction-infinite-tracing) is not supported on Alpine Linux due to a [GRPC compatibility issue](https://github.com/grpc/grpc/issues/21446). See [this agent issue](https://github.com/newrelic/newrelic-dotnet-agent/issues/289) for more information.
* The .NET agent doesn't support [Native Ahead of Time (AOT) deployment](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/?tabs=net8plus%2Cwindows) for .NET applications because just-in-time (JIT) compilation is required for the agent to function properly.

## Connect the agent to other New Relic products [#digital-intelligence-platform]
## Connect the agent to other New Relic products [#digital-intelligence-platform-core]

In addition to [APM](/docs/apm/new-relic-apm/getting-started/introduction-new-relic-apm), the .NET agent integrates with other New Relic products to give you end-to-end visibility:

Expand Down Expand Up @@ -930,7 +931,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
</table>

</TabsPageItem>
<TabsPageItem id="2">
<TabsPageItem id="framework">
## Requirements

Before you [install New Relic's .NET agent](/docs/apm/agents/net-agent/getting-started/introduction-new-relic-net/#installation), make sure your system meets these requirements:
Expand All @@ -948,14 +949,15 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
<DNT>**The <DNT>.NET agent </DNT> doesn't support .NET Framework versions 4.5.1, 4.5.2, and 4.6.1**</DNT>
</Collapser>
<Collapser
id="lifespan"
className="freq-link"
id="lifespan-framework"
title="Application lifespan"
>
The .NET agent uploads data at the end of each [harvest cycle](/docs/new-relic-solutions/get-started/glossary/#harvest-cycle) (once per minute). If your .NET app doesn't run that long, you can set the `service element`'s `sendDataOnExit` attribute to `true` in the `newrelic.config` file.
</Collapser>
<Collapser
className="freq-link"
id="app-web-servers"
id="app-web-servers-framework"
title="App/web servers"
>
You must use one of these app/web servers:
Expand All @@ -970,39 +972,43 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
The agent automatically creates transactions for apps hosted in IIS. If you self-host with WCF and OWIN version 3 or higher, the agent also automatically creates transactions. For other self-hosted services, you will need to [create transactions via custom instrumentation](/docs/apm/agents/net-agent/custom-instrumentation/introduction-net-custom-instrumentation/#new-existing).
</Collapser>
<Collapser
id="aws-elastic-beanstalk"
className="freq-link"
id="aws-elastic-beanstalk-framework"
title="AWS Elastic Beanstalk"
>
AWS [Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk) isn't a supported .NET environment.
</Collapser>

<Collapser
className="freq-link"
id="clrs"
id="clrs-framework"
title="CLRs"
>
The agent requires CLR version 4.0. Legacy applications running on CLR 2.0 can be instrumented with agent versions lower than 7.0.
</Collapser>
<Collapser
className="freq-link"
id="code-access"
id="code-access-framework"
title="Code Access Security"
>
The use of [Code Access Security](https://docs.microsoft.com/en-us/dotnet/framework/misc/code-access-security) is compatible with the .NET agent only when Full Trust is provided. The agent isn't compatible with more restrictive trust levels.
</Collapser>
<Collapser
className="freq-link"
id="azure"
id="azure-framework"
title="Microsoft Azure"
>
For Azure-specific installation instructions, see the [.NET installation guide](/install/dotnet/).
</Collapser>
<Collapser title="Network requirements">
<Collapser
className="freq-link"
id="network-reqs-framework"
title="Network requirements">
The agent requires your firewall to allow outgoing connections to specific [networks and ports](/docs/new-relic-solutions/get-started/networks/).
</Collapser>
<Collapser
className="freq-link"
id="operating-system"
id="operating-system-framework"
title="Operating system"
>
The agent requires one of these operating systems:
Expand All @@ -1021,7 +1027,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
</Collapser>
<Collapser
className="freq-link"
id="user-rights"
id="user-rights-framework"
title="Permissions"
>
Installation requires elevated privileges (Administrator). For example, you can:
Expand Down Expand Up @@ -1050,21 +1056,21 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
</Collapser>
<Collapser
className="freq-link"
id="security-requirements"
id="security-requirements-framework"
title="Security requirements"
>
As a standard [security measure for data collection](/docs/security/security-privacy/data-privacy/security-controls-privacy/), your app server must support SHA-2 (256-bit). SHA-1 isn't supported.
</Collapser>

<Collapser
className="freq-link"
id="other-apm"
id="other-apm-framework"
title="Use of other monitoring software"
>
The .NET Common Language Runtime (CLR) only allows one profiler to access the profiling API of a process at any given time. Running our .NET agent alongside other monitoring software will result in a [profiler conflict](/docs/apm/agents/net-agent/troubleshooting/profiler-conflicts/). For more information, see [Errors while using other APM software](/docs/apm/new-relic-apm/troubleshooting/errors-while-using-other-apm-software).
</Collapser>
</CollapserGroup>
## Automatic instrumentation [#instrumented-features]
## Automatic instrumentation [#instrumented-features-framework]

If your application is hosted in ASP.NET or another [fully supported framework](#app-frameworks-framework), the .NET agent will automatically instrument your application after install. If your app isn't automatically instrumented, or if you want to add instrumentation, use [custom instrumentation](/docs/apm/agents/net-agent/custom-instrumentation/introduction-net-custom-instrumentation/).

Expand Down Expand Up @@ -1098,7 +1104,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="binding-types"
id="binding-types-framework"
title="Binding types"
>
WCF Instrumentation has been tested for the following common[binding types](https://docs.microsoft.com/en-us/dotnet/framework/wcf/system-provided-bindings) (both client and service). Varying levels of support are available for distributed tracing (DT) and cross application tracing (CAT):
Expand Down Expand Up @@ -1211,7 +1217,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="database"
id="database-framework"
title="Datastores"
>
Collecting [instance details](/docs/apm/applications-menu/features/analyze-database-instance-level-performance-issues) for supported datastores requires .NET agent version 6.5.29.0 or higher and is enabled by default. To request instance-level information from datastores not currently listed, get support at [New Relic support center](https://support.newrelic.com).
Expand Down Expand Up @@ -1518,7 +1524,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="additional-frameworks"
id="additional-frameworks-framework"
title="External call libraries"
>
The agent automatically instruments these external call libraries:
Expand Down Expand Up @@ -1597,7 +1603,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="hosting-models"
id="hosting-models-framework"
title="Hosting Models"
>
The following hosting models are fully supported:
Expand All @@ -1607,7 +1613,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="hosting-models"
id="hosting-models-framework"
title="Invocation models"
>
The following invocation methods (both client and service) are supported:
Expand Down Expand Up @@ -1666,7 +1672,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="logging-frameworks"
id="logging-frameworks-framework"
title="Logging frameworks"
>
The .NET agent [can be configured](/docs/apm/agents/net-agent/configuration/net-agent-configuration/#application_logging) to automatically instrument these logging frameworks for automatic logs-in-context with [agent forwarding](/docs/logs/logs-context/net-configure-logs-context-all/#1-agent) and [local log decoration](/docs/logs/logs-context/net-configure-logs-context-all/#2-decorate):
Expand Down Expand Up @@ -1759,7 +1765,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="messaging"
id="messaging-framework"
title="Messaging"
>
The agent automatically instruments these message systems:
Expand Down Expand Up @@ -1876,7 +1882,8 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
</table>
</Collapser>
<Collapser
id="technologies"
className="freq-link"
id="technologies-framework"
title="Supported .NET languages and technologies for dashboards"
>
The listed .NET languages and technologies are compatible with our [instant observability](https://newrelic.com/instant-observability/) dashboards. If you use any of these languages or technologies, you can view your data in a New Relic dashboard, right out of the box:
Expand Down Expand Up @@ -1940,7 +1947,7 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co

<Collapser
className="freq-link"
id="unsupported-frameworks"
id="unsupported-frameworks-framework"
title="Unsupported frameworks"
>
These frameworks are **not fully supported:**
Expand All @@ -1951,11 +1958,11 @@ Want to try out our .NET agent? [Create a New Relic account](https://newrelic.co
* Sharepoint is <DNT>**not supported**</DNT>.
</Collapser>
</CollapserGroup>
### Unavailable features [#unavailable-features]
### Unavailable features [#unavailable-features-framework]

Just-in-time (JIT) compilation is a requirement for .NET agent functionality, so native images created with [Native Image Generator (NGEN)](https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator) aren't supported by the .NET agent.

### Connect the agent to other New Relic products [#digital-intelligence-platform]
### Connect the agent to other New Relic products [#digital-intelligence-platform-framework]

In addition to [APM](/docs/apm/new-relic-apm/getting-started/introduction-apm/), the agent integrates with other New Relic products to give you end-to-end visibility:

Expand Down

0 comments on commit 50ee245

Please sign in to comment.