Skip to content

Commit

Permalink
Add Supported Technologies section (elastic#362)
Browse files Browse the repository at this point in the history
* Add Supported Technologies section

* Fix formatting

* Replace "Since agent's version" by "Supported since agent's version"

* Change [[supported-technologies-details]] attribute to [[supported-technologies]]

Co-Authored-By: Brandon Morelli <[email protected]>
  • Loading branch information
SergeyKleyman and bmorelli25 authored Jul 7, 2019
1 parent ed1db14 commit 2457a06
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ endif::[]

include::./intro.asciidoc[Introduction]
include::./setup.asciidoc[Set Up]
include::./supported-technologies.asciidoc[Supported Technologies]
include::./metrics.asciidoc[Metrics]
include::./configuration.asciidoc[Configuration]
include::./public-api.asciidoc[API documentation]
Expand Down
1 change: 1 addition & 0 deletions docs/intro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Welcome to the APM .NET Agent documentation.

Elastic APM automatically measures the performance of your application and tracks errors.
For example, it records spans for database queries and transactions for incoming HTTP requests.
See <<supported-technologies>> to learn about which frameworks and technologies are supported by Elastic APM .NET agent.

Spans are grouped in transactions - by default one for each incoming HTTP request.
But it's possible to create custom transactions not associated with an HTTP request.
Expand Down
84 changes: 84 additions & 0 deletions docs/supported-technologies.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
ifdef::env-github[]
NOTE: For the best reading experience,
please view this documentation at https://www.elastic.co/guide/en/apm/agent/dotnet[elastic.co]
endif::[]

[[supported-technologies]]
== Supported Technologies
This page describes the technologies supported by the Elastic APM .NET agent.

If your favorite technology is not supported yet,
you can vote for it by participating in our
https://docs.google.com/forms/d/18SgsVo9asGNFMjRqwdrk3wTHNwPhtHv4jE35hZRCL6A/[survey].
We will use the results to add support for the most requested technologies.

Another option is to add a dependency to the agent's <<public-api, public API>>
in order to programmatically create custom transactions and spans.

If you want to extend the auto-instrumentation capabilities of the agent,
the https://github.com/elastic/apm-agent-dotnet/blob/master/CONTRIBUTING.md[contributing guide] should get you started.

NOTE: If, for example,
the HTTP client library of your choice is not listed,
it means that there won't be spans for those outgoing HTTP requests.
If the web framework you are using is not supported,
the agent will not capture transactions.

[float]
[[supported-dotnet-flavors]]
=== .NET versions

The agent works on every .NET flavor and version that supports .NET Standard 2.0.
This means .NET Core 2.0 (or newer) and .NET Framework 4.6.1 (or newer).

[float]
[[supported-web-frameworks]]
=== Web Frameworks

Automatic instrumentation for a web framework means
a transaction is automatically created for each incoming request and it is named after the registered route.

We support automatic instrumentation for the following web frameworks.

|===
|Framework |Supported versions |Supported since agent's version

|ASP.NET Core
|2.x
|1.0

|===


[float]
[[supported-data-access-technologies]]
=== Data Access Technologies

We support automatic instrumentation for the following data access technologies.

|===
|Data access technology |Supported versions |Notes |Supported since agent's version

|Entity Framework (EF) Core
|2.x
|A DB span is automatically created for each access to underlying database performed by Entity Framework Core.
|1.0

|===

[float]
[[supported-networking-client-side-technologies]]
=== Networking client-side technologies

Automatic instrumentation for networking client-side technology means
an HTTP span is automatically created for each outgoing HTTP request and tracing headers are propagated.
The spans are named after the schema `<method> <host>`, for example `GET elastic.co`.

|===
|Framework |Supported versions |Supported since agent's version

|System.Net.Http.HttpClient on .NET Core
|
|1.0

|===

0 comments on commit 2457a06

Please sign in to comment.