Class: Gitlab::TopologyServiceClient::MetricsInterceptor

Inherits:
GRPC::ClientInterceptor
  • Object
show all
Defined in:
lib/gitlab/topology_service_client/metrics_interceptor.rb

Overview

gRPC client interceptor for recording OpenTelemetry metrics Records call duration, request/response sizes, and status codes

Instance Method Summary collapse

Constructor Details

#initialize(cell_id:, topology_service_address:) ⇒ MetricsInterceptor

Returns a new instance of MetricsInterceptor.



8
9
10
11
 
# File 'lib/gitlab/topology_service_client/metrics_interceptor.rb', line 8

def initialize(cell_id:, topology_service_address:)
  super()
  @metrics = Metrics.new(cell_id: cell_id, topology_service_address: topology_service_address)
end

Instance Method Details

#bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil) ⇒ Object

Intercept bidirectional streaming RPC calls



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/gitlab/topology_service_client/metrics_interceptor.rb', line 96

def bidi_streamer(requests: nil, call: nil, method: nil, metadata: nil) # rubocop:disable Lint/UnusedMethodArgument -- all and metadata are unused but required by gRPC interceptor interface
  start_time = monotonic_time
  service_name, method_name = extract_service_and_method(method)
  request_size = { total: 0 } # Use hash to track size by reference
  response_size = { total: 0 } # Use hash to track size by reference

  begin
    # Wrap requests to track sizes
    requests_enum = Enumerator.new do |yielder|
      requests.each do |request|
        request_size[:total] += estimate_message_size(request)
        yielder.yield request
      end
    end

    # Call the next handler
    responses_enum = yield(requests_enum) # Handler consumes wrapped stream, measuring each request

    # Return enumerator that wraps responses and tracks metrics
    Enumerator.new do |yielder|
      responses_enum.each do |response|
        response_size[:total] += estimate_message_size(response)
        yielder.yield response
      end

      # Record metrics after stream completes successfully
      record_metrics(
        service: service_name,
        method: method_name,
        start_time: start_time,
        status_code: GRPC::Core::StatusCodes::OK,
        request_size: request_size[:total],
        response_size: response_size[:total]
      )
    end
  rescue GRPC::BadStatus => e
    record_metrics(
      service: service_name,
      method: method_name,
      start_time: start_time,
      status_code: e.code,
      request_size: request_size[:total],
      response_size: response_size[:total],
      error_type: classify_error(e)
    )
    raise
  rescue StandardError => e
    record_metrics(
      service: service_name,
      method: method_name,
      start_time: start_time,
      status_code: GRPC::Core::StatusCodes::UNKNOWN,
      request_size: request_size[:total],
      response_size: response_size[:total],
      error_type: classify_error(e)
    )
    raise
  end
end

#client_streaming(requests: nil, call: nil, method: nil, metadata: nil) ⇒ Object

Intercept client streaming RPC calls



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gitlab/topology_service_client/metrics_interceptor.rb', line 25

def client_streaming(requests: nil, call: nil, method: nil, metadata: nil) # rubocop:disable Lint/UnusedMethodArgument -- all and metadata are unused but required by gRPC interceptor interface
  service_name, method_name = extract_service_and_method(method)
  request_size = 0

  with_metrics_recording(service: service_name, method: method_name) do
    # Collect request sizes from the stream
    requests_enum = Enumerator.new do |yielder|
      requests.each do |request|
        request_size += estimate_message_size(request)
        yielder.yield request
      end
    end
    response = yield(requests_enum) # Handler consumes wrapped stream, measuring each request
    { response: response, response_size: estimate_message_size(response), request_size: request_size }
  end
end

#request_response(request: nil, call: nil, method: nil, metadata: nil) ⇒ Object

Intercept unary request-response RPC calls



14
15
16
17
18
19
20
21
22
 
# File 'lib/gitlab/topology_service_client/metrics_interceptor.rb', line 14

def request_response(request: nil, call: nil, method: nil, metadata: nil) # rubocop:disable Lint/UnusedMethodArgument -- all and metadata are unused but required by gRPC interceptor interface
  service_name, method_name = extract_service_and_method(method)
  request_size = estimate_message_size(request)

  with_metrics_recording(service: service_name, method: method_name, request_size: request_size) do
    response = yield
    { response: response, response_size: estimate_message_size(response) }
  end
end

#server_streaming(request: nil, call: nil, method: nil, metadata: nil) ⇒ Object

Intercept server streaming RPC calls



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
 
# File 'lib/gitlab/topology_service_client/metrics_interceptor.rb', line 43

def server_streaming(request: nil, call: nil, method: nil, metadata: nil) # rubocop:disable Lint/UnusedMethodArgument -- all and metadata are unused but required by gRPC interceptor interface
  start_time = monotonic_time
  service_name, method_name = extract_service_and_method(method)
  request_size = estimate_message_size(request)
  response_size = { total: 0 } # Use hash to track size by reference

  begin
    # Call the next handler
    responses_enum = yield

    # Return enumerator that wraps responses and tracks metrics
    Enumerator.new do |yielder|
      responses_enum.each do |response|
        response_size[:total] += estimate_message_size(response)
        yielder.yield response
      end

      # Record metrics after stream completes successfully
      record_metrics(
        service: service_name,
        method: method_name,
        start_time: start_time,
        status_code: GRPC::Core::StatusCodes::OK,
        request_size: request_size,
        response_size: response_size[:total]
      )
    end
  rescue GRPC::BadStatus => e
    record_metrics(
      service: service_name,
      method: method_name,
      start_time: start_time,
      status_code: e.code,
      request_size: request_size,
      response_size: response_size[:total],
      error_type: classify_error(e)
    )
    raise
  rescue StandardError => e
    record_metrics(
      service: service_name,
      method: method_name,
      start_time: start_time,
      status_code: GRPC::Core::StatusCodes::UNKNOWN,
      request_size: request_size,
      response_size: response_size[:total],
      error_type: classify_error(e)
    )
    raise
  end
end