lib/opentelemetry/trace/status.rb in opentelemetry-api-0.7.0 vs lib/opentelemetry/trace/status.rb in opentelemetry-api-0.8.0
- old
+ new
@@ -7,41 +7,41 @@
require 'opentelemetry/trace/util/http_to_status'
module OpenTelemetry
module Trace
# Status represents the status of a finished {Span}. It is composed of a
- # canonical code in conjunction with an optional descriptive message.
+ # status code in conjunction with an optional descriptive message.
class Status
# Convenience utility, not in API spec:
extend Util::HttpToStatus
- # Retrieve the canonical code of this Status.
+ # Retrieve the status code of this Status.
#
# @return [Integer]
- attr_reader :canonical_code
+ attr_reader :code
# Retrieve the description of this Status.
#
# @return [String]
attr_reader :description
# Initialize a Status.
#
- # @param [Integer] canonical_code One of the canonical status codes below
+ # @param [Integer] code One of the status codes below
# @param [String] description
- def initialize(canonical_code, description: '')
- @canonical_code = canonical_code
+ def initialize(code, description: '')
+ @code = code
@description = description
end
# Returns false if this {Status} represents an error, else returns true.
#
# @return [Boolean]
def ok?
- @canonical_code != ERROR
+ @code != ERROR
end
- # The following represents the canonical set of status codes of a
+ # The following represents the set of status codes of a
# finished {Span}
# The operation completed successfully.
OK = 0