Module: Google::Cloud::Trace::LabelKey

Defined in:
lib/google/cloud/trace/label_key.rb

Overview

A collection of well-known label keys for trace spans.

Constant Summary collapse

AGENT = 
"/agent"
COMPONENT = 
"/component"
ERROR_MESSAGE = 
"/error/message"
ERROR_NAME = 
"/error/name"
HTTP_CLIENT_CITY = 
"/http/client_city"
HTTP_CLIENT_COUNTRY = 
"/http/client_country"
HTTP_CLIENT_PROTOCOL = 
"/http/client_protocol"
HTTP_CLIENT_REGION = 
"/http/client_region"
HTTP_HOST = 
"/http/host"
HTTP_METHOD = 
"/http/method"
HTTP_REDIRECTED_URL = 
"/http/redirected_url"
HTTP_REQUEST_SIZE = 
"/http/request/size"
HTTP_RESPONSE_SIZE = 
"/http/response/size"
HTTP_STATUS_CODE = 
"/http/status_code"
HTTP_URL = 
"/http/url"
HTTP_USER_AGENT = 
"/http/user_agent"
PID = 
"/pid"
STACKTRACE = 
"/stacktrace"
TID = 
"/tid"
GAE_APPLICATION_ERROR = 
"g.co/gae/application_error"
GAE_APP_MODULE = 
"g.co/gae/app/module"
GAE_APP_MODULE_VERSION = 
"g.co/gae/app/module_version"
GAE_APP_VERSION = 
"g.co/gae/app/version"
GAE_DATASTORE_COUNT = 
"g.co/gae/datastore/count"
GAE_DATASTORE_CURSOR = 
"g.co/gae/datastore/cursor"
GAE_DATASTORE_ENTITY_WRITES = 
"g.co/gae/datastore/entity_writes"
GAE_DATASTORE_HAS_ANCESTOR = 
"g.co/gae/datastore/has_ancestor"
GAE_DATASTORE_HAS_CURSOR = 
"g.co/gae/datastore/has_cursor"
GAE_DATASTORE_HAS_TRANSACTION = 
"g.co/gae/datastore/has_transaction"
GAE_DATASTORE_INDEX_WRITES = 
"g.co/gae/datastore/index_writes"
GAE_DATASTORE_KIND = 
"g.co/gae/datastore/kind"
GAE_DATASTORE_LIMIT = 
"g.co/gae/datastore/limit"
GAE_DATASTORE_MORE_RESULTS = 
"g.co/gae/datastore/more_results"
GAE_DATASTORE_OFFSET = 
"g.co/gae/datastore/offset"
GAE_DATASTORE_REQUESTED_ENTITY_DELETES = 
"g.co/gae/datastore/requested_entity_deletes"
GAE_DATASTORE_REQUESTED_ENTITY_PUTS = 
"g.co/gae/datastore/requested_entity_puts"
GAE_DATASTORE_SIZE = 
"g.co/gae/datastore/size"
GAE_DATASTORE_SKIPPED = 
"g.co/gae/datastore/skipped"
GAE_DATASTORE_TRANSACTION_HANDLE = 
"g.co/gae/datastore/transaction_handle"
GAE_ERROR_MESSAGE = 
"g.co/gae/error_message"
GAE_MEMCACHE_COUNT = 
"g.co/gae/memcache/count"
GAE_MEMCACHE_SIZE = 
"g.co/gae/memcache/size"
GAE_REQUEST_LOG_ID = 
"g.co/gae/request_log_id"

Class Method Summary collapse

Class Method Details

.set_stack_trace(labels, stack_frames: nil, skip_frames: 1, truncate_stack: nil, filter_stack: nil) ⇒ Object

Set the stack trace label in the given labels hash. The current call stack is formatted so the Stackdriver UI will display it.

Examples:

require "google/cloud/trace"

trace = Google::Cloud::Trace.new
span = trace.create_span "root_span"
Google::Cloud::Trace::LabelKey.set_stack_trace span.labels

Parameters:

  • labels (Hash) —

    The labels hash in which to set the stack trace label value.

  • stack_frames (Array<Thread::Backtrace::Location>) —

    The current caller stack as returned from ::Kernel.caller_locations. If not set, ::Kernel.caller_locations is called internally.

  • skip_frames (Integer) —

    Passed to the internal invocation of ::Kernel.caller_locations if one is needed.

  • truncate_stack (Proc) —

    A procedure that allows skipping of the "topmost" stack frames. Stack frames, represented by instances of Thread::Backtrace::Location, are passed to this proc beginning with the topmost frame. As long as the proc returns a falsy value, those frames are dropped. Once the proc returns true for the first time, that frame and all remaining frames (possibly subject to filter_stack) are used. If not set, no frames are skipped.

  • filter_stack (Proc) —

    A procedure that allows skipping of stack frames in the middle of the stack trace. After possibly skipping frames using truncate_stack, all remaining frames are passed to this proc as Thread::Backtrace::Location objects. Those for whom the proc returns a falsy value are skipped. If this parameter is not set, no filtering is done and all frames are presented in the stack trace.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/google/cloud/trace/label_key.rb', line 107

def self.set_stack_trace labels,
                         stack_frames: nil, skip_frames: 1,
                         truncate_stack: nil, filter_stack: nil
  stack_frames ||= ::Kernel.caller_locations skip_frames
  json_frames = []
  collecting_frames = !truncate_stack
  stack_frames.each do |frame|
    collecting_frames ||= truncate_stack.call(frame)
    next unless collecting_frames
    next unless !filter_stack || filter_stack.call(frame)
    json_frames <<
      {
        file_name: frame.absolute_path,
        line_number: frame.lineno,
        method_name: frame.label
      }
  end
  json_object = { stack_frame: json_frames }
  labels[STACKTRACE] = JSON.generate json_object
end