Supported Technologies

edit

This page describes the technologies supported by the Elastic APM Go agent.

If your favorite technology is not supported yet, you can vote for it by participating in our survey, or joining the conversation in the Discuss forum. We will use the results of the survey and Discuss topics to add support for the most requested technologies.

If you would like to get more involved, take a look at the contributing guide.

The Elastic APM Go agent naturally requires Go. We will support, at a minimum, the last two major Go releases as described by Go’s Release Policy. Older versions of Go will be supported on a best-effort basis.

We currently test the agent with all major versions of Go since 1.8. Some integration modules may require a more recent version of Go due to third-party dependencies.

Web Frameworks

edit

We support several third-party web frameworks, as well as Go’s standard net/http package. Regardless of the framework, we create a transaction for each incoming request, and name the transaction after the registered route.

httprouter

edit

julienschmidt/httprouter does not use semantic versioning, but its API is relatively stable. Any recent version should be compatible with the Elastic APM Go agent.

See module/apmhttprouter for more information about httprouter instrumentation.

Echo

edit

We support the Echo web framework, v3.2.2 and greater.

See module/apmecho for more information about Echo instrumentation.

Gin

edit

We support the Gin web framework, v1.2 and greater.

See module/apmgin for more information about Gin instrumentation.

gorilla/mux

edit

We support gorilla/mux v1.6.1 and greater. Older versions are not supported due to the use of gorilla.Middleware.

See module/apmgorilla for more information about gorilla/mux instrumentation.

Databases

edit

database/sql

edit

We support tracing requests with any database/sql driver, provided the driver is registered with the Elastic APM Go agent. Spans will be created for each statemented executed.

When using one of the following drivers, the Elastic APM Go agent will be able to parse the datasource name, and provide more context in the spans it emits:

See module/apmsql for more information about database/sql instrumentation.

GORM

edit

We support the GORM object-relational mapping library, v1.9 and greater. Spans will be created for each create, query, update, and delete operation.

As with database/sql support we provide additional support for the postgres, mysql, and sqlite dialects.

See module/apmgorm for more information about GORM instrumentation.

Cassandra (gocql)

edit

GoCQL does not have a stable API, so we will provide support for the most recent API, and older versions of the API on a best-effort basis. Spans will be created for each query. When the batch API is used, a span will be created for the batch, and a sub-span is created for each query in the batch.

See module/apmgocql for more information about GoCQL instrumentation.

RPC Frameworks

edit

gRPC

edit

We support gRPC v1.3.0 and greater. We provide unary interceptors for both the client and server. The server interceptor will create a transaction for each incoming request, and the client interceptor will create a span for each outgoing request.

See module/apmgrpc for more information about gRPC instrumentation.