Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elastic/apm-agent-dotnet

apm error-monitoring performance-analysis performance-monitoring tracing

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/elastic/apm-agent-dotnet
Owner: elastic
License: apache-2.0
Created: 2018-10-31T16:46:26.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2025-01-19T22:38:44.000Z (13 days ago)
Last Synced: 2025-01-23T13:01:42.787Z (9 days ago)
Topics: apm, error-monitoring, performance-analysis, performance-monitoring, tracing
Language: C#
Homepage: https://www.elastic.co/guide/en/apm/agent/dotnet/current/index.html
Size: 10.1 MB
Stars: 588
Watchers: 235
Forks: 206
Open Issues: 102
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.asciidoc
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
- Support: docs/supported-technologies.asciidoc

Awesome Lists containing this project

README

        # apm-agent-dotnet

[![Build Status](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-dotnet/apm-agent-dotnet-mbp/main)](https://apm-ci.elastic.co/job/apm-agent-dotnet/job/apm-agent-dotnet-mbp/job/main/)

[![codecov](https://codecov.io/gh/elastic/apm-agent-dotnet/branch/main/graph/badge.svg)](https://codecov.io/gh/elastic/apm-agent-dotnet)

Please fill out this survey to help us prioritize framework support:

[https://goo.gl/forms/FHHbhptcDx8eDNx92](https://goo.gl/forms/FHHbhptcDx8eDNx92)

## Installation

Official NuGet packages can be referenced from [NuGet.org](https://www.nuget.org).

| Package Name            | Purpose          | Download         |

| ----------------------- | ---------------- | -----------------|

| `Elastic.Apm`           |  The core of the Agent, Public Agent API, Auto instrumentation for libraries that are part of .NET Standard 2.0.  | [![NuGet Release][ElasticApm-image]][ElasticApm-nuget-url]  |

| `Elastic.Apm.AspNetCore` | ASP.NET Core auto instrumentation. | [![NuGet Release][ElasticApmAspNetCore-image]][ElasticApmAspNetCore-nuget-url] |

| `Elastic.Apm.EntityFrameworkCore` | Entity Framework Core auto instrumentation. | [![NuGet Release][Elastic.Apm.EntityFrameworkCore-image]][Elastic.Apm.EntityFrameworkCore-nuget-url] |

| `Elastic.Apm.NetCoreAll` | References every .NET Core related Elastic APM package. It can be used to simply turn on the agent and activate all auto instrumentation. | [![NuGet Release][Elastic.Apm.NetCoreAll-image]][Elastic.Apm.NetCoreAll-nuget-url] |

| `Elastic.Apm.AspNetFullFramework` | ASP.NET (classic) auto instrumentation with an IIS Module. | [![NuGet Release][Elastic.Apm.AspNetFullFramework-image]][Elastic.Apm.AspNetFullFramework-nuget-url] |

| `Elastic.Apm.EntityFramework6` | Entity Framework 6 auto instrumentation. | [![NuGet Release][Elastic.Apm.EntityFramework6-image]][Elastic.Apm.EntityFramework6-nuget-url] |

| `Elastic.Apm.Elasticsearch` | Integration with the .NET clients for Elasticsearch. | [![NuGet Release][Elastic.Apm.Elasticsearch-image]][Elastic.Apm.Elasticsearch-nuget-url] |

| `Elastic.Apm.StackExchange.Redis` | Integration with the StackExchange.Redis client for Redis. | [![NuGet Release][Elastic.Apm.StackExchange.Redis-image]][Elastic.Apm.StackExchange.Redis-nuget-url] |

| `Elastic.Apm.MongoDb` | Integration with the MongoDb.Driver driver for MongoDb. | [![NuGet Release][Elastic.Apm.MongoDb-image]][Elastic.Apm.MongoDb-nuget-url] |

| `Elastic.Apm.Azure.ServiceBus` | Integration with Azure ServiceBus | [![NuGet Release][Elastic.Apm.Azure.ServiceBus-image]][Elastic.Apm.Azure.ServiceBus-nuget-url] |

| `Elastic.Apm.Azure.Storage` | Integration with Azure Storage | [![NuGet Release][Elastic.Apm.Azure.Storage-image]][Elastic.Apm.Azure.Storage-nuget-url] |

| `Elastic.Apm.Azure.CosmosDb` | Integration with Azure CosmosDB | [![NuGet Release][Elastic.Apm.Azure.CosmosDb-image]][Elastic.Apm.Azure.CosmosDb-nuget-url] |

## Documentation

Docs are located [here](https://www.elastic.co/guide/en/apm/agent/dotnet/). That page is generated from the content of the [docs](docs) folder.

## Getting Help

If you have any feedback feel free to [open an issue](https://github.com/elastic/apm-agent-dotnet/issues/new).

For any other assistance, please open or add to a topic on the [APM discuss forum](https://discuss.elastic.co/c/apm).

If you need help or hit an issue, please start by opening a topic on our discuss forums.

Please note that we reserve GitHub tickets for confirmed bugs and enhancement requests.

## Contributing

See the [contributing documentation](CONTRIBUTING.md)

## Releasing

See the [releasing documentation](RELEASING.md)

## Repository structure

These are the main folders within the repository:

* `src`: The source code of the agent. Each project within this folder targets a specific library, and there is one core project, which is referenced by all other projects.

  * `Elastic.Apm`: The core project targeting .NET Standard 2.0. It contains the [Agent API](/docs/public-api.asciidoc), the infrastructure to report data to the APM Server, the logging infrastructure, and auto-instrumentation for things that are part of .NET Standard 2.0.

  * `Elastic.Apm.AspNetCore`: Auto-instrumentation for ASP.NET Core.

  * `Elastic.Apm.EntityFrameworkCore`: Auto-instrumentation for EntityFramework Core.

  * `Elastic.Apm.NetCoreAll`: A convenient project that references all other .NET Core related projects from the `src` folder. It contains an ASP.NET Core middleware extension that enables the agent and every other component with a single line of code. In a typical ASP.NET Core application (e.g. apps referencing [Microsoft.AspNetCore.All](https://www.nuget.org/packages/Microsoft.AspNetCore.All)) that uses EF Core the `Elastic.Apm.NetCoreAll` can be referenced.

  * `Elastic.Apm.AspNetFullFramework`: Auto-instrumentation for ASP.NET (classic).

  * `Elastic.Apm.EntityFramework6`: Auto-instrumentation for Entity Framework 6.

  * `Elastic.Apm.SqlClient`: Auto-instrumentation for `System.Data.SqlClient` and `Microsoft.Data.SqlClient`.

  * `Elastic.Apm.Elasticsearch`: Auto-instrumentation for the official .NET clients for Elasticsearch.

  * `Elastic.Apm.StackExchange.Redis`: Auto-instrumentation for the StackExchange.Redis client for Redis.

  * `Elastic.Apm.MongoDb`: Instrumentation for the MongoDb.Driver driver for MongoDb.

  * `Elastic.Apm.Azure.ServiceBus`: Instrumentation for Azure ServiceBus.

  * `Elastic.Apm.Azure.Storage`: Instrumentation for Azure Storage.

* `test`: This folder contains test projects. Typically each project from the `src` folder has a corresponding test project.

  * `Elastic.Apm.Tests`: Tests the `Elastic.Apm` project.

  * `Elastic.Apm.AspNetCore.Tests`: Tests the `Elastic.Apm.AspNetCore` project.

  * `Elastic.Apm.AspNetFullFramework.Tests`: Tests the `Elastic.Apm.AspNetFullFramework` project.

  * `Elastic.Apm.Tests.MockApmServer`: Implementation of APM Server mock used for agent-as-component tests (for example in `Elastic.Apm.AspNetFullFramework.Tests`).

* `docs`: This folder contains the official documentation.

* `sample`: Sample applications that are monitored by the APM .NET Agent. These are also very useful for development: you can start one of these applications and debug the agent through them.

* `.build`: Contains files used when building the solution, and [a project to perform

common build tasks](build/README.md).

* `.ci`: This folder contains all the scripts used to build, test and release the agent within the CI.

## License

Elastic APM .NET Agent is licensed under Apache License, Version 2.0.

[ElasticApm-nuget-url]:https://www.nuget.org/packages/Elastic.Apm/

[ElasticApm-image]:

https://img.shields.io/nuget/v/Elastic.Apm.svg

[ElasticApmAspNetCore-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.AspNetCore/

[ElasticApmAspNetCore-image]:

https://img.shields.io/nuget/v/Elastic.Apm.AspNetCore.svg

[Elastic.Apm.EntityFrameworkCore-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.EntityFrameworkCore/

[Elastic.Apm.EntityFrameworkCore-image]:

https://img.shields.io/nuget/v/Elastic.Apm.EntityFrameworkCore.svg

[Elastic.Apm.NetCoreAll-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.NetCoreAll/

[Elastic.Apm.NetCoreAll-image]:

https://img.shields.io/nuget/v/Elastic.Apm.NetCoreAll.svg

[Elastic.Apm.AspNetFullFramework-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.AspNetFullFramework/

[Elastic.Apm.AspNetFullFramework-image]:

https://img.shields.io/nuget/v/Elastic.Apm.AspNetFullFramework.svg

[Elastic.Apm.EntityFramework6-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.EntityFramework6/

[Elastic.Apm.EntityFramework6-image]:

https://img.shields.io/nuget/v/Elastic.Apm.EntityFramework6.svg

[Elastic.Apm.Elasticsearch-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.Elasticsearch/

[Elastic.Apm.Elasticsearch-image]:

https://img.shields.io/nuget/v/Elastic.Apm.Elasticsearch.svg

[Elastic.Apm.StackExchange.Redis-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.StackExchange.Redis/

[Elastic.Apm.StackExchange.Redis-image]:

https://img.shields.io/nuget/v/Elastic.Apm.StackExchange.Redis.svg

[Elastic.Apm.MongoDb-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.MongoDb/

[Elastic.Apm.MongoDb-image]:

https://img.shields.io/nuget/v/Elastic.Apm.MongoDb.svg

[Elastic.Apm.Azure.ServiceBus-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.Azure.ServiceBus/

[Elastic.Apm.Azure.ServiceBus-image]:

https://img.shields.io/nuget/v/Elastic.Apm.Azure.ServiceBus.svg

[Elastic.Apm.Azure.Storage-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.Azure.Storage/

[Elastic.Apm.Azure.Storage-image]:

https://img.shields.io/nuget/v/Elastic.Apm.Azure.Storage.svg

[Elastic.Apm.Azure.CosmosDb-nuget-url]:https://www.nuget.org/packages/Elastic.Apm.Azure.CosmosDb/

[Elastic.Apm.Azure.CosmosDb-image]:

https://img.shields.io/nuget/v/Elastic.Apm.Azure.CosmosDb.svg