docs/api.asciidoc in elastic-apm-3.5.0 vs docs/api.asciidoc in elastic-apm-3.6.0

- old
+ new

@@ -41,10 +41,22 @@ Stop the currently running agent. Use this inside `at_exit` in your <<getting-started-rack,Rack app>> to gracefully shut down. [float] +[[api-agent-restart]] +==== `ElasticAPM.restart` + +If the agent is already running, this method will stop and start the agent. + +If the agent is not already running, this method will start the agent. + +A config can be passed to the method that will be used to start the agent. If the agent +is already running and no config is passed to the `#restart` method, the running agent's +config will be used. + +[float] [[api-agent-running]] ==== `ElasticAPM.running?` Returns whether the ElasticAPM Agent is currently running. @@ -423,16 +435,16 @@ - `result`: String - `trace_id`: String (readonly) [float] [[api-transaction-sampled_]] -==== #sampled? +==== `#sampled?` Whether the transaction is _sampled_ eg. it includes stacktraces for its spans. [float] [[api-transaction-ensure_parent_id]] -==== #ensure_parent_id +==== `#ensure_parent_id` If the transaction does not have a parent-ID yet, calling this method generates a new ID, sets it as the parent-ID of this transaction, and returns it as a `String`.