Class: OpenTelemetry::Trace::Status

Inherits:
Object
  • Object
show all
Extended by:
Util::HttpToStatus
Defined in:
lib/opentelemetry/trace/status.rb

Overview

Status represents the status of a finished Span. It is composed of a status code in conjunction with an optional descriptive message.

Constant Summary collapse

OK =

The operation completed successfully.

0
UNSET =

The default status.

1
ERROR =

An error.

2

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util::HttpToStatus

http_to_status

Constructor Details

#initialize(code, description: '') ⇒ Status

Initialize a Status.

Parameters:

  • code (Integer) —

    One of the status codes below

  • description (String) (defaults to: '') 


31
32
33
34
 
# File 'lib/opentelemetry/trace/status.rb', line 31

def initialize(code, description: '')
  @code = code
  @description = description
end

Instance Attribute Details

#code ⇒ Integer (readonly)

Retrieve the status code of this Status.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/opentelemetry/trace/status.rb', line 20

def code
  @code
end

#description ⇒ String (readonly)

Retrieve the description of this Status.

Returns:

  • (String) 


25
26
27
 
# File 'lib/opentelemetry/trace/status.rb', line 25

def description
  @description
end

Instance Method Details

#ok? ⇒ Boolean

Returns false if this OpenTelemetry::Trace::Status represents an error, else returns true.

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/opentelemetry/trace/status.rb', line 39

def ok?
  @code != ERROR
end