Contents

ifdef::env-github[]
NOTE: For the best reading experience, please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co]
endif::[]

= APM Ruby Agent Reference (Alpha)

== Introduction

The Elastic APM Ruby Agent sends performance metrics and error logs to an Elastic APM Server.

It has built-in support for <<getting-started-rails,Rails>> and other <<getting-started-rack,Rack-compatible>> applications.

This agent is one of several components you need to get started collecting APM data. See also:

 * https://www.elastic.co/guide/en/apm/server/current/index.html[APM Server]
 * https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[Elasticsearch]

[[framework-support]]
The Elastic APM Ruby Agent officially supports <<getting-started-rails,Rails>> versions 4.x on onwards.

For Sinatra and other Rack compatible frameworks, see <<getting-started-rack,Getting started with Rack>>.

include::./getting-started-rails.asciidoc[]
include::./getting-started-rack.asciidoc[]
include::./configuration.asciidoc[]

[[advanced]]
== Advanced Topics
include::./context.asciidoc[]
include::./custom-instrumentation.asciidoc[]

include::./api.asciidoc[]

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
elastic-apm-0.3.0	docs/index.asciidoc
elastic-apm-0.2.0	docs/index.asciidoc