Set up Elasticsearch instrumentation

For the full compatibility matrix including supported installation methods, refer to Data access technologies.

This page assumes the core agent is already set up. If not, see Set up the APM .NET Agent first.

The currently supported Elasticsearch client for .NET ships in the Elastic.Clients.Elasticsearch NuGet package. This package and the underlying transport are instrumented with OpenTelemetry native APIs built into .NET. These will be picked up automatically when the OpenTelemetry Bridge feature is enabled. No additional Elastic APM .NET Agent package is required.

Add the Elastic.Apm.Elasticsearch NuGet package to your project:

dotnet add package Elastic.Apm.{{product.elasticsearch}}
		

Pass {{product.elasticsearch}}DiagnosticsSubscriber to the AddElasticApm method in case of ASP.NET Core as follows:

using Elastic.Apm.Elasticsearch

app.Services.AddElasticApm(new {{product.elasticsearch}}DiagnosticsSubscriber());
		

or passing {{product.elasticsearch}}DiagnosticsSubscriber to the Subscribe method

using Elastic.Apm;
using Elastic.Apm.Elasticsearch

Agent.Subscribe(new {{product.elasticsearch}}DiagnosticsSubscriber());
		

Instrumentation listens for activities raised by {{product.elasticsearch}}.Net and Nest, creating spans for executed requests.