module Hoss

Hoss

Licensed to Elasticsearch B.V. under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Elasticsearch B.V. licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

require 'hoss/span/context'

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

http://www.apache.org/licenses/LICENSE-2.0

Constants

VERSION

Public Class Methods

add_filter(key, callback = nil, &block) click to toggle source

Provide a filter to transform payloads before sending them off

@param key [Symbol] Unique filter key @param callback [Object, Proc] A filter that responds to call(payload) @yield [Hash] A filter. Used if provided. Otherwise using `callback` @return [Bool] true

# File lib/hoss-agent.rb, line 202
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() click to toggle source

@return [Agent] Currently running [Agent] if any

# File lib/hoss-agent.rb, line 78
def agent
  Agent.instance
end

build_context( rack_env: nil, for_type: :transaction ) click to toggle source

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

@param rack_env [Rack::Env] A Rack env @return [Context] The built context

# File lib/hoss-agent.rb, line 127
def build_context(
  rack_env: nil,
  for_type: :transaction
)
  agent&.build_context(rack_env: rack_env, for_type: for_type)
end

current_event() click to toggle source

# File lib/hoss-agent.rb, line 116
def current_event
  agent&.current_event
end

end_event() click to toggle source

# File lib/hoss-agent.rb, line 98
def end_event
  agent&.end_event
end

log_ids() click to toggle source

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

@yield [String|nil, String|nil, String|nil] The transaction, span, and trace ids. @return [String] Unless block given

# File lib/hoss-agent.rb, line 88
def log_ids
  ids = []
  ids.join(' ')
end

report(exception, context: nil, handled: true) click to toggle source

Report and exception to APM

@param exception [Exception] The exception @param context [Context] An optional [Context] @param handled [Boolean] Whether the exception was rescued @return [String] ID of the generated [Error]

# File lib/hoss-agent.rb, line 142
def report(exception, context: nil, handled: true)
  agent&.report(exception, context: context, handled: handled)
end

report_message(message, context: nil, **attrs) click to toggle source

Report a custom string error message to APM

@param message [String] The message @param context [Context] An optional [Context] @return [String] ID of the generated [Error]

# File lib/hoss-agent.rb, line 151
def report_message(message, context: nil, **attrs)
  agent&.report_message(
    message,
    context: context,
    backtrace: caller,
    **attrs
  )
end

restart(config = nil) click to toggle source

Restarts the Hoss 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.

# File lib/hoss-agent.rb, line 66
def restart(config = nil)
  config ||= agent&.config
  stop if running?
  start(config)
end

running?() click to toggle source

@return [Boolean] Whether there's an [Agent] running

# File lib/hoss-agent.rb, line 73
def running?
  Agent.running?
end

set_custom_context(custom) click to toggle source

Provide further context for the current transaction

@param custom [Hash] A hash with custom information. Can be nested. @return [Hash] The current custom context

# File lib/hoss-agent.rb, line 184
def set_custom_context(custom)
  agent&.set_custom_context(custom)
end

set_label(key, value) click to toggle source

Set a label value for the current transaction

@param key [String,Symbol] A key @param value [Object] A value @return [Object] The given value

# File lib/hoss-agent.rb, line 167
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_user(user) click to toggle source

Provide a user to the current transaction

@param user [Object] An object representing a user @return [Object] Given user

# File lib/hoss-agent.rb, line 192
def set_user(user)
  agent&.set_user(user)
end

start(config = {}) click to toggle source

Starts the Hoss Agent

@param config [Config] An instance of Config @return [Agent] The resulting [Agent]

# File lib/hoss-agent.rb, line 53
def start(config = {})
  Agent.start config
end

start_event() click to toggle source

# File lib/hoss-agent.rb, line 93
def start_event
  agent&.start_event.tap do |event|
  end
end

stop() click to toggle source

Stops the Hoss Agent

# File lib/hoss-agent.rb, line 58
def stop
  Agent.stop
end

with_event() { |event| ... } click to toggle source

# File lib/hoss-agent.rb, line 102
def with_event
  unless block_given?
    raise ArgumentError,
      'expected a block. Do you want `start_event\' instead?'
  end

  begin
    event = start_event
    yield event
  ensure
    end_event
  end
end