Module: NewRelic::Agent::Instrumentation::Kinesis

Included in:
Kinesis::Prepend
Defined in:
lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb

Defined Under Namespace

Modules: Chain, Prepend

Constant Summary collapse

INSTRUMENTED_METHODS = 
%w[
  add_tags_to_stream
  create_stream
  decrease_stream_retention_period
  delete_stream
  describe_limits
  describe_stream
  disable_enhanced_monitoring
  enable_enhanced_monitoring
  get_records
  get_shard_iterator
  increase_stream_retention_period
  list_streams
  list_tags_for_stream
  merge_shards
  put_record
  put_records
  remove_tags_from_stream
  split_shard
  update_shard_count
].freeze
KINESIS = 
'Kinesis'
AWS_KINESIS_DATA_STREAMS = 
'aws_kinesis_data_streams'
MESSAGE_BROKER_SEGMENT_METHODS = 
%w[put_record put_records get_records].freeze

Instance Method Summary collapse

Instance Method Details

#get_arn(params) ⇒ Object

[View source]

83
84
85
86
87
88
89
 
# File 'lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb', line 83

def get_arn(params)
  stream_arn = params&.dig(:stream_arn)
  return stream_arn if stream_arn

  stream_name = params&.dig(:stream_name)
  NewRelic::Agent::Aws.create_arn(KINESIS.downcase, "stream/#{stream_name}", config&.region, ) if stream_name
end

#get_segment_name(method_name, params) ⇒ Object

[View source]

62
63
64
65
66
67
68
69
 
# File 'lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb', line 62

def get_segment_name(method_name, params)
  stream_name = params&.dig(:stream_name)
  return "#{KINESIS}/#{method_name}/#{stream_name}" if stream_name

  "#{KINESIS}/#{method_name}"
rescue => e
  NewRelic::Agent.logger.warn("Failed to create segment name: #{e}")
end

#get_stream_name(params, arn) ⇒ Object

[View source]

71
72
73
74
75
 
# File 'lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb', line 71

def get_stream_name(params, arn)
  params&.dig(:stream_name) || arn.split('/').last || 'unknown'
rescue => e
  NewRelic::Agent.logger.warn("Failed to get stream name: #{e}")
end

#instrument_method_with_new_relic(method_name, *args) ⇒ Object

[View source]

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
 
# File 'lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb', line 33

def instrument_method_with_new_relic(method_name, *args)
  return yield unless NewRelic::Agent::Tracer.tracing_enabled?

  NewRelic::Agent.record_instrumentation_invocation(KINESIS)
  params = args[0]
  arn = get_arn(params) if params

  if MESSAGE_BROKER_SEGMENT_METHODS.include?(method_name)
    stream_name = get_stream_name(params, arn)
    segment = NewRelic::Agent::Tracer.start_message_broker_segment(
      action: method_name == 'get_records' ? :consume : :produce,
      library: KINESIS,
      destination_type: :stream,
      destination_name: stream_name
    )
  else
    segment = NewRelic::Agent::Tracer.start_segment(name: get_segment_name(method_name, params))
  end

  segment&.add_agent_attribute('cloud.resource_id', arn) if arn

  begin
    NewRelic::Agent::Tracer.capture_segment_error(segment) { yield }
  ensure
    segment&.add_agent_attribute('cloud.platform', AWS_KINESIS_DATA_STREAMS)
    segment&.finish
  end
end

#nr_account_id ⇒ Object

[View source]

77
78
79
80
81
 
# File 'lib/new_relic/agent/instrumentation/aws_sdk_kinesis/instrumentation.rb', line 77

def 
  return @nr_account_id if defined?(@nr_account_id)

  @nr_account_id = NewRelic::Agent::Aws.(config)
end