Class: Appsignal::GarbageCollectionProfiler Private

Inherits:
Object
  • Object
show all
Defined in:
lib/appsignal/garbage_collection_profiler.rb

Overview

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.

GarbageCollectionProfiler wraps Ruby's GC::Profiler to be able to track garbage collection time for multiple transactions, while constantly clearing GC::Profiler's total_time to make sure it doesn't leak memory by keeping garbage collection run samples in memory.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GarbageCollectionProfiler

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 GarbageCollectionProfiler.



15
16
17
 
# File 'lib/appsignal/garbage_collection_profiler.rb', line 15

def initialize
  @total_time = 0
end

Class Method Details

.lock ⇒ 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. 



11
12
13
 
# File 'lib/appsignal/garbage_collection_profiler.rb', line 11

def self.lock
  @lock ||= Mutex.new
end

Instance Method Details

#total_time ⇒ Integer

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.

Whenever #total_time is called, the current GC::Profiler#total_time gets added to @total_time, after which GC::Profiler.clear is called to prevent it from leaking memory. A class-level lock is used to make sure garbage collection time is never counted more than once.

Whenever @total_time gets above two billion milliseconds (about 23 days), it's reset to make sure the result fits in a signed 32-bit integer.

Returns:

  • (Integer) 


29
30
31
32
33
34
35
36
37
38
 
# File 'lib/appsignal/garbage_collection_profiler.rb', line 29

def total_time
  lock.synchronize do
    @total_time += (internal_profiler.total_time * 1000).round
    internal_profiler.clear
  end

  @total_time = 0 if @total_time > 2_000_000_000

  @total_time
end