Module: Atatus

Defined in:
lib/atatus.rb,
lib/atatus/sql.rb,
lib/atatus/grpc.rb,
lib/atatus/span.rb,
lib/atatus/util.rb,
lib/atatus/agent.rb,
lib/atatus/error.rb,
lib/atatus/grape.rb,
lib/atatus/rails.rb,
lib/atatus/spies.rb,
lib/atatus/config.rb,
lib/atatus/resque.rb,
lib/atatus/context.rb,
lib/atatus/graphql.rb,
lib/atatus/logging.rb,
lib/atatus/metrics.rb,
lib/atatus/railtie.rb,
lib/atatus/sinatra.rb,
lib/atatus/version.rb,
lib/atatus/metadata.rb,
lib/atatus/error/log.rb,
lib/atatus/metricset.rb,
lib/atatus/middleware.rb,
lib/atatus/spies/http.rb,
lib/atatus/spies/json.rb,
lib/atatus/spies/rake.rb,
lib/atatus/spies/tilt.rb,
lib/atatus/sql/tokens.rb,
lib/atatus/stacktrace.rb,
lib/atatus/subscriber.rb,
lib/atatus/metrics/set.rb,
lib/atatus/normalizers.rb,
lib/atatus/opentracing.rb,
lib/atatus/spies/mongo.rb,
lib/atatus/spies/redis.rb,
lib/atatus/transaction.rb,
lib/atatus/config/bytes.rb,
lib/atatus/context/user.rb,
lib/atatus/deprecations.rb,
lib/atatus/instrumenter.rb,
lib/atatus/span/context.rb,
lib/atatus/span_helpers.rb,
lib/atatus/spies/resque.rb,
lib/atatus/spies/sequel.rb,
lib/atatus/error_builder.rb,
lib/atatus/spies/faraday.rb,
lib/atatus/spies/sidekiq.rb,
lib/atatus/spies/sinatra.rb,
lib/atatus/sql/signature.rb,
lib/atatus/sql/tokenizer.rb,
lib/atatus/trace_context.rb,
lib/atatus/util/throttle.rb,
lib/atatus/central_config.rb,
lib/atatus/collector/base.rb,
lib/atatus/collector/hist.rb,
lib/atatus/config/options.rb,
lib/atatus/internal_error.rb,
lib/atatus/metrics/metric.rb,
lib/atatus/metrics/vm_set.rb,
lib/atatus/spies/net_http.rb,
lib/atatus/spies/sneakers.rb,
lib/atatus/sql_summarizer.rb,
lib/atatus/transport/base.rb,
lib/atatus/util/inflector.rb,
lib/atatus/util/lru_cache.rb,
lib/atatus/child_durations.rb,
lib/atatus/collector/layer.rb,
lib/atatus/config/duration.rb,
lib/atatus/context/company.rb,
lib/atatus/context/request.rb,
lib/atatus/context_builder.rb,
lib/atatus/error/exception.rb,
lib/atatus/span/context/db.rb,
lib/atatus/spies/dynamo_db.rb,
lib/atatus/spies/shoryuken.rb,
lib/atatus/context/response.rb,
lib/atatus/naively_hashable.rb,
lib/atatus/stacktrace/frame.rb,
lib/atatus/transport/worker.rb,
lib/atatus/collector/builder.rb,
lib/atatus/span/context/http.rb,
lib/atatus/spies/delayed_job.rb,
lib/atatus/transport/filters.rb,
lib/atatus/transport/headers.rb,
lib/atatus/config/regexp_list.rb,
lib/atatus/spies/sucker_punch.rb,
lib/atatus/stacktrace_builder.rb,
lib/atatus/collector/transport.rb,
lib/atatus/context/request/url.rb,
lib/atatus/metrics/cpu_mem_set.rb,
lib/atatus/spies/elasticsearch.rb,
lib/atatus/metadata/system_info.rb,
lib/atatus/transport/connection.rb,
lib/atatus/transport/user_agent.rb,
lib/atatus/metadata/process_info.rb,
lib/atatus/metadata/service_info.rb,
lib/atatus/metrics/breakdown_set.rb,
lib/atatus/spies/action_dispatch.rb,
lib/atatus/transport/serializers.rb,
lib/atatus/context/request/socket.rb,
lib/atatus/metrics/span_scoped_set.rb,
lib/atatus/metrics/transaction_set.rb,
lib/atatus/span/context/destination.rb,
lib/atatus/trace_context/tracestate.rb,
lib/atatus/trace_context/traceparent.rb,
lib/atatus/transport/connection/http.rb,
lib/atatus/central_config/cache_control.rb,
lib/atatus/config/wildcard_pattern_list.rb,
lib/atatus/metadata/system_info/hw_info.rb,
lib/atatus/metadata/system_info/os_info.rb,
lib/atatus/normalizers/rails/action_view.rb,
lib/atatus/normalizers/grape/endpoint_run.rb,
lib/atatus/normalizers/rails/action_mailer.rb,
lib/atatus/normalizers/rails/active_record.rb,
lib/atatus/transport/connection/proxy_pipe.rb,
lib/atatus/transport/filters/hash_sanitizer.rb,
lib/atatus/transport/filters/secrets_filter.rb,
lib/atatus/metadata/system_info/container_info.rb,
lib/atatus/normalizers/rails/action_controller.rb,
lib/atatus/transport/serializers/span_serializer.rb,
lib/atatus/transport/serializers/error_serializer.rb,
lib/atatus/transport/serializers/context_serializer.rb,
lib/atatus/transport/serializers/metadata_serializer.rb,
lib/atatus/transport/serializers/metricset_serializer.rb,
lib/atatus/transport/serializers/transaction_serializer.rb

Overview

frozen_string_literal: true

Defined Under Namespace

Modules: ChildDurations, Collector, Deprecations, Grape, GraphQL, Logging, Metrics, NaivelyHashable, Normalizers, OpenTracing, Rails, Resque, Sinatra, SpanHelpers, Spies, Sql, Transport, Util Classes: Agent, BaseTransport, Builder, CentralConfig, Config, Context, ContextBuilder, Error, ErrorBuilder, ExistingTransactionError, GRPC, Instrumenter, InternalError, Metadata, Metricset, Middleware, Railtie, Span, SqlSummarizer, Stacktrace, StacktraceBuilder, Subscriber, TraceContext, Transaction

Constant Summary collapse

AGENT_NAME = 
'Ruby'
VERSION = 
'1.7.0'

Class Method Summary collapse

Class Method Details

.add_filter(key, callback = nil) {|Hash| ... } ⇒ Bool

Provide a filter to transform payloads before sending them off

Parameters:

  • key (Symbol) —

    Unique filter key

  • callback (Object, Proc) (defaults to: nil) —

    A filter that responds to #call(payload)

Yields:

  • (Hash) —

    A filter. Used if provided. Otherwise using ‘callback`

Returns:

  • (Bool) —

    true



401
402
403
404
405
406
407
 
# File 'lib/atatus.rb', line 401

def add_filter(key, callback = nil, &block)
  if callback.nil? && !block_given?
    raise ArgumentError, '#add_filter needs either `callback\' or a block'
  end

  agent&.add_filter(key, block || callback)
end

.agent ⇒ Agent

Returns Currently running [Agent] if any.

Returns:

  • (Agent) —

    Currently running [Agent] if any



83
84
85
 
# File 'lib/atatus.rb', line 83

def agent
  Agent.instance
end

.build_context(rack_env: nil, for_type: :transaction) ⇒ Context

Build a [Context] from a Rack ‘env`. The context may include information about the request, response, current user and more

Parameters:

  • rack_env (Rack::Env) (defaults to: nil) —

    A Rack env

Returns:



302
303
304
305
306
307
 
# File 'lib/atatus.rb', line 302

def build_context(
  rack_env: nil,
  for_type: :transaction
)
  agent&.build_context(rack_env: rack_env, for_type: for_type)
end

.current_span ⇒ Span

Returns the currently active span (if any)

Returns:

  • (Span) —

    or ‘nil`



99
100
101
 
# File 'lib/atatus.rb', line 99

def current_span
  agent&.current_span
end

.current_transaction ⇒ Transaction

Returns the currently active transaction (if any)

Returns:



92
93
94
 
# File 'lib/atatus.rb', line 92

def current_transaction
  agent&.current_transaction
end

.end_span ⇒ Span

Ends the current span

Returns:



239
240
241
 
# File 'lib/atatus.rb', line 239

def end_span
  agent&.end_span
end

.end_transaction(result = nil) ⇒ Transaction

Ends the current transaction with ‘result`

Parameters:

  • result (String) (defaults to: nil) —

    The result of the transaction

Returns:



150
151
152
 
# File 'lib/atatus.rb', line 150

def end_transaction(result = nil)
  agent&.end_transaction(result)
end

.log_ids {|String|nil, String|nil, String|nil| ... } ⇒ String

Get a formatted string containing transaction, span, and trace ids. If a block is provided, the ids are yielded.

and trace ids.

Yields:

  • (String|nil, String|nil, String|nil) —

    The transaction, span,

Returns:

  • (String) —

    Unless block given



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/atatus.rb', line 109

def log_ids
  trace_id = (current_transaction || current_span)&.trace_id
  if block_given?
    return yield(current_transaction&.id, current_span&.id, trace_id)
  end

  ids = []
  ids << "transaction.id=#{current_transaction.id}" if current_transaction
  ids << "span.id=#{current_span.id}" if current_span
  ids << "trace.id=#{trace_id}" if trace_id
  ids.join(' ')
end

.report(exception, context: nil, handled: true) ⇒ String

Report and exception to APM

Parameters:

  • exception (Exception) —

    The exception

  • context (Context) (defaults to: nil) —

    An optional [Context]

  • handled (Boolean) (defaults to: true) —

    Whether the exception was rescued

Returns:

  • (String) —

    ID of the generated [Error]



317
318
319
 
# File 'lib/atatus.rb', line 317

def report(exception, context: nil, handled: true)
  agent&.report(exception, context: context, handled: handled)
end

.report_message(message, context: nil, **attrs) ⇒ String

Report a custom string error message to APM

Parameters:

  • message (String) —

    The message

  • context (Context) (defaults to: nil) —

    An optional [Context]

Returns:

  • (String) —

    ID of the generated [Error]



326
327
328
329
330
331
332
333
 
# File 'lib/atatus.rb', line 326

def report_message(message, context: nil, **attrs)
  agent&.report_message(
    message,
    context: context,
    backtrace: caller,
    **attrs
  )
end

.restart(config = nil) ⇒ Object

Restarts the Atatus Agent using the same config or a new one, if it is provided. Starts the agent if it is not running. Stops and starts the agent if it is running.



71
72
73
74
75
 
# File 'lib/atatus.rb', line 71

def restart(config = nil)
  config ||= agent&.config
  stop if running?
  start(config)
end

.running? ⇒ Boolean

Returns Whether there’s an [Agent] running.

Returns:

  • (Boolean) —

    Whether there’s an [Agent] running



78
79
80
 
# File 'lib/atatus.rb', line 78

def running?
  Agent.running?
end

.set_company(company) ⇒ Object

Provide a company to the current transaction

Parameters:

  • company (Object) —

    An object representing a company

Returns:

  • (Object) —

    Given company



383
384
385
 
# File 'lib/atatus.rb', line 383

def set_company(company)
  agent&.set_company(company)
end

.set_custom_context(custom) ⇒ Hash

Provide further context for the current transaction

Parameters:

  • custom (Hash) —

    A hash with custom information. Can be nested.

Returns:

  • (Hash) —

    The current custom context



367
368
369
 
# File 'lib/atatus.rb', line 367

def set_custom_context(custom)
  agent&.set_custom_context(custom)
end

.set_custom_data(custom) ⇒ Hash

Provide further context for the current transaction

Parameters:

  • custom (Hash) —

    A hash with custom information. Can be nested.

Returns:

  • (Hash) —

    The current custom context



359
360
361
 
# File 'lib/atatus.rb', line 359

def set_custom_data(custom)
  agent&.set_custom_context(custom)
end

.set_label(key, value) ⇒ Object

Set a label value for the current transaction

Parameters:

  • key (String, Symbol) —

    A key

  • value (Object) —

    A value

Returns:

  • (Object) —

    The given value



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/atatus.rb', line 342

def set_label(key, value)
  case value
  when TrueClass,
       FalseClass,
       Numeric,
       NilClass,
       String
    agent&.set_label(key, value)
  else
    agent&.set_label(key, value.to_s)
  end
end

.set_response_body(response_body) ⇒ String

Provide the response body to the current transaction

Parameters:

  • response_body (String) —

    A string containing the response body

Returns:

  • (String) —

    Given response body



391
392
393
 
# File 'lib/atatus.rb', line 391

def set_response_body(response_body)
  agent&.set_response_body(response_body.to_s)
end

.set_user(user) ⇒ Object

Provide a user to the current transaction

Parameters:

  • user (Object) —

    An object representing a user

Returns:

  • (Object) —

    Given user



375
376
377
 
# File 'lib/atatus.rb', line 375

def set_user(user)
  agent&.set_user(user)
end

.start(config = {}) ⇒ Agent

Starts the Atatus Agent

Parameters:

  • config (Config) (defaults to: {}) —

    An instance of Config

Returns:

  • (Agent) —

    The resulting [Agent]



58
59
60
 
# File 'lib/atatus.rb', line 58

def start(config = {})
  Agent.start config
end

.start_span(name, type = nil, subtype: nil, action: nil, context: nil, include_stacktrace: true, trace_context: nil, parent: nil, sync: nil) ⇒ Span

rubocop:disable Metrics/ParameterLists Start a new span

Parameters:

  • name (String) —

    A description of the span, eq ‘SELECT FROM “users”`

  • type (String) (defaults to: nil) —

    The span type, eq ‘db`

  • subtype (String) (defaults to: nil) —

    The span subtype, eq ‘postgresql`

  • action (String) (defaults to: nil) —

    The span action type, eq ‘connect` or `query`

  • context (Span::Context) (defaults to: nil) —

    Context information about the span

  • include_stacktrace (Boolean) (defaults to: true) —

    Whether or not to capture a stacktrace

  • trace_context (TraceContext) (defaults to: nil) —

    An optional [TraceContext] object for Distributed Tracing.

  • parent (Transaction, Span) (defaults to: nil) —

    The parent transaction or span. Relevant when the span is created in another thread.

  • sync (Boolean) (defaults to: nil) —

    Whether the span is created synchronously or not.

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/atatus.rb', line 207

def start_span(
  name,
  type = nil,
  subtype: nil,
  action: nil,
  context: nil,
  include_stacktrace: true,
  trace_context: nil,
  parent: nil,
  sync: nil
)
  agent&.start_span(
    name,
    type,
    subtype: subtype,
    action: action,
    context: context,
    trace_context: trace_context,
    parent: parent,
    sync: sync
  ).tap do |span|
    break unless span && include_stacktrace
    break unless agent.config.span_frames_min_duration?

    span.original_backtrace ||= caller
  end
end

.start_transaction(name = nil, type = nil, context: nil, trace_context: nil) ⇒ Transaction

Start a new transaction

‘ExamplesController#index` `db.mysql2.query`

Parameters:

  • name (String) (defaults to: nil) —

    A description of the transaction, eg

  • type (String) (defaults to: nil) —

    The kind of the transaction, eg ‘app.request.get` or

  • context (Context) (defaults to: nil) —

    An optional [Context]

  • trace_context (TraceContext) (defaults to: nil) —

    An optional [TraceContext] object for Distributed Tracing.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/atatus.rb', line 132

def start_transaction(
  name = nil,
  type = nil,
  context: nil,
  trace_context: nil
)
  agent&.start_transaction(
    name,
    type,
    context: context,
    trace_context: trace_context
  )
end

.stop ⇒ Object

Stops the Atatus Agent



63
64
65
 
# File 'lib/atatus.rb', line 63

def stop
  Agent.stop
end

.with_span(name, type = nil, subtype: nil, action: nil, context: nil, include_stacktrace: true, trace_context: nil, parent: nil, sync: nil) {|Span| ... } ⇒ Object

rubocop:disable Metrics/ParameterLists Wrap a block in a Span, ending it after the block

Parameters:

  • name (String) —

    A description of the span, eq ‘SELECT FROM “users”`

  • type (String) (defaults to: nil) —

    The kind of span, eq ‘db`

  • subtype (String) (defaults to: nil) —

    The subtype of span eg. ‘postgresql`.

  • action (String) (defaults to: nil) —

    The action type of span eg. ‘connect` or `query`.

  • context (Span::Context) (defaults to: nil) —

    Context information about the span

  • include_stacktrace (Boolean) (defaults to: true) —

    Whether or not to capture a stacktrace

  • trace_context (TraceContext) (defaults to: nil) —

    An optional [TraceContext] object for Distributed Tracing.

  • parent (Transaction, Span) (defaults to: nil) —

    The parent transaction or span. Relevant when the span is created in another thread.

  • sync (Boolean) (defaults to: nil) —

    Whether the span is created synchronously or not.

Yields:

Returns:

  • Result of block



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/atatus.rb', line 259

def with_span(
  name,
  type = nil,
  subtype: nil,
  action: nil,
  context: nil,
  include_stacktrace: true,
  trace_context: nil,
  parent: nil,
  sync: nil
)
  unless block_given?
    raise ArgumentError,
      'expected a block. Do you want `start_span\' instead?'
  end

  return yield nil unless agent

  begin
    span =
      start_span(
        name,
        type,
        subtype: subtype,
        action: action,
        context: context,
        include_stacktrace: include_stacktrace,
        trace_context: trace_context,
        parent: parent,
        sync: sync
      )
    yield span
  ensure
    end_span
  end
end

.with_transaction(name = nil, type = nil, context: nil, trace_context: nil) {|Transaction| ... } ⇒ Object

Wrap a block in a Transaction, ending it after the block

‘ExamplesController#index` `db.mysql2.query`

Parameters:

  • name (String) (defaults to: nil) —

    A description of the transaction, eg

  • type (String) (defaults to: nil) —

    The kind of the transaction, eg ‘app.request.get` or

  • context (Context) (defaults to: nil) —

    An optional [Context]

  • trace_context (TraceContext) (defaults to: nil) —

    An optional [TraceContext] object for Distributed Tracing.

Yields:

Returns:

  • result of block



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/atatus.rb', line 165

def with_transaction(
  name = nil,
  type = nil,
  context: nil,
  trace_context: nil
)
  unless block_given?
    raise ArgumentError,
      'expected a block. Do you want `start_transaction\' instead?'
  end

  return yield(nil) unless agent

  begin
    transaction =
      start_transaction(
        name,
        type,
        context: context,
        trace_context: trace_context
      )
    yield transaction
  ensure
    end_transaction
  end
end