elastic-apm 3.0.0 → 3.1.0

data/CHANGELOG.md

@@ -1,359 +1 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## 3.0.0 (2019-10-08)
-
-### Breaking Changes
-
-The following changes are breaking, as they may change the way data is grouped or shown in Kibana or how your app
-defines agent settings.
-
-- Decrease stack_trace_limit to 50 ([#515](https://github.com/elastic/apm-agent-ruby/pull/515))
-- Errors' `message` no longer include their `type` ([#323](https://github.com/elastic/apm-agent-ruby/pull/323/files))
-- External request spans now have type `external.http.{library}` ([#514](https://github.com/elastic/apm-agent-ruby/pull/514))
-- Durations are measured using monotonic time ([#550](https://github.com/elastic/apm-agent-ruby/pull/550))
-- Rename set_tag to set_label ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
-- Rename disabled_spies to disabled_instrumentations ([#539](https://github.com/elastic/apm-agent-ruby/pull/539))
-
-## 2.12.0 (2019-10-01)
-
-### Changed
-
-- `disabled_spies` renamed to `disabled_instrumentations` with fallback ([#539](https://github.com/elastic/apm-agent-ruby/pull/539))
-- Rename `set_tag` to `set_label` and deprecate `set_tag` ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
-- Allow non-String label values ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
-
-### Fixed
-
-- Handles a case where stacktrace frames are empty ([#538](https://github.com/elastic/apm-agent-ruby/pull/538))
-
-### Deprecated
-
-- Deprecate `set_tag` ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
-
-## 2.11.0 (2019-09-23)
-
-### Added
-
-- Add `Rails` module with `#start` method to run Rails setup explicitly ([#522](https://github.com/elastic/apm-agent-ruby/pull/522))
-- Support for log/trace correlation ([#527](https://github.com/elastic/apm-agent-ruby/pull/527))
-
-### Changed
-
-- Split dot-separated `span.type` into `.type`, `.subtype` and `.action` (auto-upgrades dot style) ([#531](https://github.com/elastic/apm-agent-ruby/pull/531))
-
-## 2.10.1
-
-### Fixed
-
-- Fixed loading options from a config file specified by `ELASTIC_APM_CONFIG_FILE` ([#518](https://github.com/elastic/apm-agent-ruby/pull/518))
-- Fixed an issue with CentralConfig polling not starting ([#525](https://github.com/elastic/apm-agent-ruby/pull/525))
-
-### Added
-
-- Support for chained exceptions ([#488](https://github.com/elastic/apm-agent-ruby/pull/488))
-
-## 2.10.0
-
-### Added
-
-- Add Ruby specific metrics ([#437](https://github.com/elastic/apm-agent-ruby/pull/437))
-- Support for APM Agent Configuration via Kibana ([#464](https://github.com/elastic/apm-agent-ruby/pull/464))
-- Change span name format and add command to context's db.statement for `MongoSpy` ([#488](https://github.com/elastic/apm-agent-ruby/pull/490))
-
-### Changed
-
-- `ElasticAPM.report` and `ElasticAPM.report_message` return the string ID of the generated `Error` objects ([#507](https://github.com/elastic/apm-agent-ruby/pull/507))
-
-## 2.9.1 (2019-06-28)
-
-### Fixed
-
-- Use system CA certificate if none is specified ([#460](https://github.com/elastic/apm-agent-ruby/pull/460))
-
-## 2.9.0 (2019-06-25)
-
-### Security
-
-- **NB:** If you are using a custom CA cert via `server_ca_cert`, versions of the agent prior to 2.9.0 may not have validated the certificate of APM Server correctly.
-
-### Added
-
-- Add `transaction.type` to errors ([#434](https://github.com/elastic/apm-agent-ruby/pull/434))
-- Add cookies to `request.cookies` ([#448](https://github.com/elastic/apm-agent-ruby/pull/448))
-
-### Fixed
-
-- Fix support for older versions of Http.rb ([#438](https://github.com/elastic/apm-agent-ruby/pull/434))
-- Strip `Cookie` and `Set-Cookie` from headers ([#448](https://github.com/elastic/apm-agent-ruby/pull/448))
-- Fix disabling SSL verification ([#449](https://github.com/elastic/apm-agent-ruby/pull/449))
-
-## 2.8.1 (2019-05-29)
-
-### Fixed
-
-- Database statements are properly truncated ([#431](https://github.com/elastic/apm-agent-ruby/pull/431))
-
-## 2.8.0 (2019-05-20)
-
-### Added
-
-- The option `stack_trace_limit` ([#424](https://github.com/elastic/apm-agent-ruby/pull/424))
-
-### Changed
-
-- Use standardized User-Agent ([#419](https://github.com/elastic/apm-agent-ruby/pull/419))
-
-### Fixed
-
-- `error.culprit` is properly truncated to 1024 characters ([#418](https://github.com/elastic/apm-agent-ruby/pull/418))
-- Force convert `transaction.context.response.status_code` to integer ([#423](https://github.com/elastic/apm-agent-ruby/pull/423))
-
-## 2.7.0 (2019-05-07)
-
-### Added
-
-- Added `disable_start_message` for those wanting complete silence on boot ([#397](https://github.com/elastic/apm-agent-ruby/pull/397))
-
-### Changed
-
-- Attempt to strip secrets from `request.env` ([#410](https://github.com/elastic/apm-agent-ruby/pull/410))
-
-### Fixed
-
-- Rewritten most of the internal transport code, streaming events to APM Server ([#372](https://github.com/elastic/apm-agent-ruby/pull/372))
-- Re-added `default_tags` ([#395](https://github.com/elastic/apm-agent-ruby/pull/395))
-- A bug in the Faraday spy when disabling the Net::HTTP spy ([#396](https://github.com/elastic/apm-agent-ruby/pull/396))
-- Fix disabling the ActionDispatch spy ([#399](https://github.com/elastic/apm-agent-ruby/pull/399))
-
-## 2.6.1 (2019-03-28)
-
-### Fixed
-
-- Setting `config_file` via `ELASTIC_APM_CONFIG_FILE` ([#363(https://github.com/elastic/apm-agent-ruby/pull/363))
-- Stopping the Metrics collector when it is disabled ([#357](https://github.com/elastic/apm-agent-ruby/pull/357))
-- HTTP proxy settings can now be set by ENV variable ([#367](https://github.com/elastic/apm-agent-ruby/pull/367))
-
-## 2.6.0 (2019-03-19)
-
-### Deprecated
-
-- `ElasticAPM.build_context` now takes two keyword arguments instead of a single, normal argument. [Docs](https://www.elastic.co/guide/en/apm/agent/ruby/2.x/api.html#api-agent-build-context).
-- The option `capture_body` has a string value instead of boolean. [Docs](https://www.elastic.co/guide/en/apm/agent/ruby/2.x/configuration.html#config-capture-body).
-
-Both APIs are backwards compatible with fallbacks and deprecation warnings, scheduled for removal in next major release.
-
-### Added
-
-- Configuration options to use an HTTP proxy ([#352](https://github.com/elastic/apm-agent-ruby/pull/352))
-
-### Changed
-
-- Errors get their own contexts, perhaps leading to slightly different (but more correct) results. ([#335](https://github.com/elastic/apm-agent-ruby/pull/335))
-- The agent no longer starts automatically inside Rails' console ([#343](https://github.com/elastic/apm-agent-ruby/pull/343))
-
-### Fixed
-
-- Fixed reading available memory on older Linux kernels ([#351](https://github.com/elastic/apm-agent-ruby/pull/351))
-- Don't apply filters to original response headers ([#354](https://github.com/elastic/apm-agent-ruby/pull/354))
-
-## 2.5.0 (2019-03-01)
-
-### Added
-
-- Added the option `active` that will prevent the agent from starting if set to `false` ([#338](https://github.com/elastic/apm-agent-ruby/pull/338))
-
-### Fixed
-
-- Fix error with `capture_body` and nested request bodies ([#339](https://github.com/elastic/apm-agent-ruby/pull/339))
-
-## 2.4.0 (2019-02-27)
-
-### Added
-
-- Added option to specify a custom server CA certificate ([#315](https://github.com/elastic/apm-agent-ruby/pull/315))
-
-### Changed
-
-- **NB:** Default value of option `capture_body` flipped to `false` to align with other agents. Set `capture_body: true` in your configuration to get them back. ([#324](https://github.com/elastic/apm-agent-ruby/pull/324))
-
-### Fixed
-
-- Reading CPU stats from `/proc/stat` on RHEL ([#312](https://github.com/elastic/apm-agent-ruby/pull/312))
-- Change TraceContext to differentiate between `id` and `parent_id` ([#326](https://github.com/elastic/apm-agent-ruby/pull/326))
-- `capture_body` will now force encode text bodies to utf-8 when possible ([#332](https://github.com/elastic/apm-agent-ruby/pull/332))
-
-## 2.3.1 (2019-01-31)
-
-### Added
-
-- Read container info from Docker or Kupernetes ([#303](https://github.com/elastic/apm-agent-ruby/pull/303))
-
-### Fixed
-
-- Fix logging exceptions when booting via Railtie ([#306](https://github.com/elastic/apm-agent-ruby/pull/306))
-
-## 2.3.0 (2019-01-29)
-
-### Added
-
-- Support for Metrics ([#276](https://github.com/elastic/apm-agent-ruby/pull/276))
-
-## 2.2.0 (2019-01-22)
-
-### Added
-
-- Support for [OpenTracing](https://opentracing.io) ([#273](https://github.com/elastic/apm-agent-ruby/pull/273))
-- Add capture\_\* options ([#279](https://github.com/elastic/apm-agent-ruby/pull/279))
-- Evaluate the config file as ERB ([#288](https://github.com/elastic/apm-agent-ruby/pull/288))
-
-### Changed
-
-- Rename `Traceparent` object to `TraceContext` ([#271](https://github.com/elastic/apm-agent-ruby/pull/271))
-
-### Fixed
-
-- An issue where Spans would not get Stacktraces attached ([#282](https://github.com/elastic/apm-agent-ruby/pull/282))
-- Skip `caller` unless needed ([#287](https://github.com/elastic/apm-agent-ruby/pull/283))
-
-## 2.1.2 (2018-12-07)
-
-### Fixed
-
-- Fix truncation of `transaction.request.url` values ([#267](https://github.com/elastic/apm-agent-ruby/pull/267))
-- Fix Faraday calls with `url_prefix` ([#263](https://github.com/elastic/apm-agent-ruby/pull/263))
-- Force `span.context.http.status_code` to be an integer
-
-## 2.1.1 (2018-12-04)
-
-### Fixed
-
-- Set traceparent span.id to transaction id when span is missing ([#261](https://github.com/elastic/apm-agent-ruby/pull/261))
-
-## 2.1.0 (2018-12-04)
-
-### Added
-
-- Support for Faraday ([#249](https://github.com/elastic/apm-agent-ruby/pull/249))
-
-### Fixed
-
-- Truncate keyword fields to 1024 chars ([#240](https://github.com/elastic/apm-agent-ruby/pull/240))
-- Lazy boot worker threads on first event. Fixes apps using Puma's `preload_app!` ([#239](https://github.com/elastic/apm-agent-ruby/pull/239))
-- Fix missing `disable_send` implementation ([#257](https://github.com/elastic/apm-agent-ruby/pull/257))
-- Add warnings for invalid config options ([#254](https://github.com/elastic/apm-agent-ruby/pull/254))
-
-## 2.0.1 (2018-11-15)
-
-### Fixed
-
-- Stop sending `span.start` ([#234](https://github.com/elastic/apm-agent-ruby/pull/234))
-
-## 2.0.0 (2018-11-14)
-
-Version adds support for APM Server 6.5 and needs at least that.
-
-### Added
-
-- Support for APM Server 6.5 (Intake v2)
-- Support for Distributed Tracing (beta)
-- Support for RUM Agent correlation (Distributed Tracing)
-- Support for [HTTP.rb](https://github.com/httprb/http) (Instrumentation + Distributed Tracing)
-
-### Changed
-
-- Custom instrumentation APIs ([#209](https://github.com/elastic/apm-agent-ruby/pull/209))
-- Tag keys will convert disallowed chars to `_`
-- Default log level changed to `info`
-- Laxed version requirement of concurrent-ruby
-- Change `log_level` to only concern agent log
-
-### Deprecated
-
-#### APIs:
-
-- `ElasticAPM.transaction`
-- `ElasticAPM.span`
-
-#### Options:
-
-- `compression_level`
-- `compression_minimum_size`
-- `debug_http`
-- `debug_transactions`
-- `flush_interval`
-- `http_open_timeout`
-- `http_read_timeout`
-- `enabled_environments`
-- `disable_environment_warning`
-
-Some options that used to take a certain unit for granted now expects explicit units – but will fall back to old default.
-
-### Removed
-
-- Support for APM Server versions prior to 6.5.
-- Support for Ruby 2.2 (eol)
-
-## 1.1.0 (2018-09-07)
-
-### Added
-
-- Rake task instrumentation ([#192](https://github.com/elastic/apm-agent-ruby/pull/192))
-- `default_tags` option ([#183](https://github.com/elastic/apm-agent-ruby/pull/183))
-
-### Fixed
-
-- Fallback from missing JRUBY_VERSION ([#180](https://github.com/elastic/apm-agent-ruby/pull/180))
-
-## 1.0.2 (2018-09-07)
-
-Should've been a minor release -- see 1.1.0
-
-## 1.0.1 (2018-07-30)
-
-### Fixed
-
-- Fixed internal LRU cache to be threadsafe ([#178](https://github.com/elastic/apm-agent-ruby/pull/178))
-
-## 1.0.0 (2018-06-29)
-
-### Added
-
-- Added config.disable_send ([#156](https://github.com/elastic/apm-agent-ruby/pull/156))
-
-### Changed
-
-- Set the default `span_frame_min_duration` to 5ms
-
-### Fixed
-
-- Fixed some Elasticsearch spans not validating JSON Schema ([#157](https://github.com/elastic/apm-agent-ruby/pull/157))
-
-## 0.8.0 (2018-06-13)
-
-### Added
-
-- Added an option to disable metrics collection ([#145](https://github.com/elastic/apm-agent-ruby/pull/145))
-- Filters can cancel the entire payload by returning `nil` ([#148](https://github.com/elastic/apm-agent-ruby/pull/148))
-- Added `ENV` version of the logging options ([#146](https://github.com/elastic/apm-agent-ruby/pull/146))
-- Added `config.ignore_url_patterns` ([#151](https://github.com/elastic/apm-agent-ruby/pull/151))
-
-### Changed
-
-- Use concurrent-ruby's TimerTask instead of `Thread#sleep`. Adds dependency on `concurrent-ruby`. ([#141](https://github.com/elastic/apm-agent-ruby/pull/141))
-
-### Fixed
-
-- Remove newline on `hostname`
-- Fixed ActionMailer spans renaming their transaction
-
-## 0.7.4 - 2018-06-07
-
-Beginning of this document
-
-### Fixed
-
-- Fix overwriting custom logger with Rails'
+Release notes are now available in our documentation at ([elastic.co](https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes.html))

data/Rakefile

@@ -3,9 +3,9 @@
 require 'bundler/gem_tasks'
 
 Rake::Task[:release].enhance do
-  `git checkout 2.x &&
+  `git checkout 3.x &&
   git rebase master &&
-  git push origin 2.x &&
+  git push origin 3.x &&
   git checkout master`
 end
 

data/docs/advanced.asciidoc

@@ -9,8 +9,6 @@ endif::[]
 
 * <<context>>
 * <<custom-instrumentation>>
-* <<opentracing>>
 
 include::./context.asciidoc[]
 include::./custom-instrumentation.asciidoc[]
-include::./opentracing.asciidoc[]

data/docs/api.asciidoc

@@ -5,7 +5,7 @@ https://www.elastic.co/guide/en/apm/agent/ruby/current/introduction.html[elastic
 endif::[]
 
 [[api]]
-== Public API
+== API reference
 
 Although most usage is covered automatically, Elastic APM also has a public
 API that allows custom usage.
@@ -203,6 +203,17 @@ the gem and using the `Railtie`.
 ElasticAPM::Rails.start(server_url: 'http://localhost:8200')
 ----
 
+[float]
+[[sinatra-start]]
+=== Sinatra
+
+Start the agent and hook into Sinatra.
+
+[source,ruby]
+----
+ElasticAPM::Sinatra.start(MySinatraApp, server_url: 'http://localhost:8200')
+----
+
 [float]
 === Errors
 

data/docs/configuration.asciidoc

@@ -53,6 +53,17 @@ ElasticAPM.start(
 )
 ----
 
+Alternatively, you can use the `ElasticAPM::Sinatra.start` API.
+
+[source,ruby]
+----
+# config.ru or similar
+ElasticAPM::Sinatra.start(
+  MyApp,
+  service_name: 'SomeOtherName'
+)
+----
+
 See <<getting-started-rack>>.
 
 [float]
@@ -221,7 +232,7 @@ Whether or not to attach `ENV` from Rack to transactions and errors.
 | `ELASTIC_APM_CENTRAL_CONFIG` | `central_config` | `true`
 |============
 
-Enable {kibana-ref}/agent-configuration.html[APM Agent Configuration via Kibana].
+Enable {apm-app-ref}/agent-configuration.html[APM Agent Configuration via Kibana].
 If set to `true`, the client will poll the APM Server regularly for new agent configuration.
 
 Usually APM Server determines how often to poll, but if not the default interval is 5 minutes.
@@ -325,13 +336,13 @@ Get an array of enabled instrumentations with `ElasticAPM.agent.config.enabled_i
 The name of the environment this service is deployed in,
 e.g. "production" or "staging".
 
-Environments allow you to easily filter data on a global level in the APM UI.
+Environments allow you to easily filter data on a global level in the APM app.
 It's important to be consistent when naming environments across agents.
-See {kibana-ref}/filters.html#environment-selector[environment selector] in the Kibana UI for more information.
+See {apm-app-ref}/filters.html#environment-selector[environment selector] in the APM app for more information.
 
 Defaults to `ENV['RAILS_ENV'] || ENV['RACK_ENV']`.
 
-NOTE: This feature is fully supported in the APM UI in Kibana versions >= 7.2.
+NOTE: This feature is fully supported in the APM app in Kibana versions >= 7.2.
 You must use the query bar to filter for a specific environment in versions prior to 7.2.
 
 [float]