Class: ElasticAPM::Context Private

Inherits:
Object
  • Object
show all
Defined in:
lib/elastic_apm/context.rb,
lib/elastic_apm/context/user.rb,
lib/elastic_apm/context/request.rb,
lib/elastic_apm/context/response.rb,
lib/elastic_apm/context/request/url.rb,
lib/elastic_apm/context/request/socket.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Classes: Framework, Request, Response, Service, User

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(custom: {}, labels: {}, user: nil, service: nil) ⇒ Context

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Context.



29
30
31
32
33
34
 
# File 'lib/elastic_apm/context.rb', line 29

def initialize(custom: {}, labels: {}, user: nil, service: nil)
  @custom = custom
  @labels = labels
  @user = user || User.new
  @service = service
end

Instance Attribute Details

#custom ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



40
41
42
 
# File 'lib/elastic_apm/context.rb', line 40

def custom
  @custom
end

#labels ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



40
41
42
 
# File 'lib/elastic_apm/context.rb', line 40

def labels
  @labels
end

#request ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



39
40
41
 
# File 'lib/elastic_apm/context.rb', line 39

def request
  @request
end

#response ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



39
40
41
 
# File 'lib/elastic_apm/context.rb', line 39

def response
  @response
end

#service ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



40
41
42
 
# File 'lib/elastic_apm/context.rb', line 40

def service
  @service
end

#user ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



39
40
41
 
# File 'lib/elastic_apm/context.rb', line 39

def user
  @user
end

Instance Method Details

#empty? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


42
43
44
45
46
47
48
49
50
 
# File 'lib/elastic_apm/context.rb', line 42

def empty?
  return false if labels.any?
  return false if custom.any?
  return false if user.any?
  return false if service
  return false if request || response

  true
end

#set_service(framework_name: nil, framework_version: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



52
53
54
55
56
 
# File 'lib/elastic_apm/context.rb', line 52

def set_service(framework_name: nil, framework_version: nil)
  @service = Service.new(
    Framework.new(framework_name, framework_version)
  )
end