Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ruby_sampler_spec.rb « samplers « metrics « gitlab « lib « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: b1566ffa7b4603618c046be1f31b78322f1e232e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::Metrics::Samplers::RubySampler do
  let(:sampler) { described_class.new }
  let(:null_metric) { double('null_metric', set: nil, observe: nil) }

  before do
    allow(Gitlab::Metrics::NullMetric).to receive(:instance).and_return(null_metric)
  end

  it_behaves_like 'metrics sampler', 'RUBY_SAMPLER'

  describe '#initialize' do
    it 'sets process_start_time_seconds' do
      freeze_time do
        expect(sampler.metrics[:process_start_time_seconds].get).to eq(Time.now.to_i)
      end
    end

    context 'when not setting a prefix' do
      it 'does not prepend metrics with that prefix' do
        expect(sampler.metrics[:process_start_time_seconds].name).to eq(:ruby_process_start_time_seconds)
      end
    end

    context 'when using custom prefix' do
      let(:sampler) { described_class.new(prefix: 'custom') }

      it 'prepends metrics with that prefix' do
        expect(sampler.metrics[:process_start_time_seconds].name).to eq(:custom_ruby_process_start_time_seconds)
      end
    end
  end

  describe '#sample' do
    it 'adds a metric containing the process resident memory bytes' do
      expect(Gitlab::Metrics::System).to receive(:memory_usage_rss).and_return(9000)

      expect(sampler.metrics[:process_resident_memory_bytes]).to receive(:set).with({}, 9000)

      sampler.sample
    end

    it 'adds a metric containing the process unique and proportional memory bytes' do
      expect(Gitlab::Metrics::System).to receive(:memory_usage_uss_pss).and_return(uss: 9000, pss: 10_000)

      expect(sampler.metrics[:process_unique_memory_bytes]).to receive(:set).with({}, 9000)
      expect(sampler.metrics[:process_proportional_memory_bytes]).to receive(:set).with({}, 10_000)

      sampler.sample
    end

    context 'when USS+PSS sampling is disabled via environment' do
      before do
        stub_env('enable_memory_uss_pss', "0")
      end

      it 'does not sample USS or PSS' do
        expect(Gitlab::Metrics::System).not_to receive(:memory_usage_uss_pss)

        expect(sampler.metrics[:process_unique_memory_bytes]).not_to receive(:set)
        expect(sampler.metrics[:process_proportional_memory_bytes]).not_to receive(:set)

        sampler.sample
      end
    end

    it 'adds a metric containing the amount of open file descriptors' do
      expect(Gitlab::Metrics::System).to receive(:file_descriptor_count)
                                           .and_return(4)

      expect(sampler.metrics[:file_descriptors]).to receive(:set).with({}, 4)

      sampler.sample
    end

    it 'adds a metric containing the process total cpu time' do
      expect(Gitlab::Metrics::System).to receive(:cpu_time).and_return(0.51)
      expect(sampler.metrics[:process_cpu_seconds_total]).to receive(:set).with({}, 0.51)

      sampler.sample
    end

    it 'adds a metric containing the process max file descriptors' do
      expect(Gitlab::Metrics::System).to receive(:max_open_file_descriptors).and_return(1024)
      expect(sampler.metrics[:process_max_fds]).to receive(:set).with({}, 1024)

      sampler.sample
    end

    it 'clears any GC profiles' do
      expect(GC::Profiler).to receive(:clear).at_least(:once)

      sampler.sample
    end
  end

  describe '#sample_gc' do
    let!(:sampler) { described_class.new }

    let(:gc_reports) { [{ GC_TIME: 0.1 }, { GC_TIME: 0.2 }, { GC_TIME: 0.3 }] }

    it 're-enables GC::Profiler if needed' do
      expect(GC::Profiler).to receive(:enable)

      sampler.sample
    end

    it 'observes GC cycles time' do
      expect(sampler).to receive(:sample_gc_reports).and_return(gc_reports)

      expect(sampler.metrics[:gc_duration_seconds]).to receive(:observe).with({}, 0.1).ordered
      expect(sampler.metrics[:gc_duration_seconds]).to receive(:observe).with({}, 0.2).ordered
      expect(sampler.metrics[:gc_duration_seconds]).to receive(:observe).with({}, 0.3).ordered

      sampler.sample
    end

    it 'adds a metric containing garbage collection statistics' do
      GC.stat.keys.each do |key|
        expect(sampler.metrics[key]).to receive(:set).with({}, anything)
      end

      sampler.sample
    end

    it 'adds a heap fragmentation metric' do
      expect(sampler.metrics[:heap_fragmentation]).to receive(:set).with({}, anything)

      sampler.sample
    end
  end
end