mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
577b21745b
* Update codes to match specification * Add changes to changelog * go mod tidy * Add unit tests for codes * Update SetStatus methods to only filter Unset * Update apitest code being tested
100 lines
2.6 KiB
Go
100 lines
2.6 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package codes defines the canonical error codes used by OpenTelemetry.
|
|
//
|
|
// It conforms to [the OpenTelemetry
|
|
// specification](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#statuscanonicalcode).
|
|
package codes // import "go.opentelemetry.io/otel/codes"
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
)
|
|
|
|
const (
|
|
// Unset is the default status code.
|
|
Unset Code = 0
|
|
// Error indicates the operation contains an error.
|
|
Error Code = 1
|
|
// Ok indicates operation has been validated by an Application developers
|
|
// or Operator to have completed successfully, or contain no error.
|
|
Ok Code = 2
|
|
|
|
maxCode = 3
|
|
)
|
|
|
|
// Code is an 32-bit representation of a status state.
|
|
type Code uint32
|
|
|
|
var codeToStr = map[Code]string{
|
|
Unset: "Unset",
|
|
Error: "Error",
|
|
Ok: "Ok",
|
|
}
|
|
|
|
var strToCode = map[string]Code{
|
|
"Unset": Unset,
|
|
"Error": Error,
|
|
"Ok": Ok,
|
|
}
|
|
|
|
// String returns the Code as a string.
|
|
func (c Code) String() string {
|
|
return codeToStr[c]
|
|
}
|
|
|
|
// UnmarshalJSON unmarshals b into the Code.
|
|
//
|
|
// This is based on the functionality in the gRPC codes package:
|
|
// https://github.com/grpc/grpc-go/blob/bb64fee312b46ebee26be43364a7a966033521b1/codes/codes.go#L218-L244
|
|
func (c *Code) UnmarshalJSON(b []byte) error {
|
|
// From json.Unmarshaler: By convention, to approximate the behavior of
|
|
// Unmarshal itself, Unmarshalers implement UnmarshalJSON([]byte("null")) as
|
|
// a no-op.
|
|
if string(b) == "null" {
|
|
return nil
|
|
}
|
|
if c == nil {
|
|
return fmt.Errorf("nil receiver passed to UnmarshalJSON")
|
|
}
|
|
|
|
if ci, err := strconv.ParseUint(string(b), 10, 32); err == nil {
|
|
if ci >= maxCode {
|
|
return fmt.Errorf("invalid code: %q", ci)
|
|
}
|
|
|
|
*c = Code(ci)
|
|
return nil
|
|
}
|
|
|
|
if jc, ok := strToCode[string(b)]; ok {
|
|
*c = jc
|
|
return nil
|
|
}
|
|
return fmt.Errorf("invalid code: %q", string(b))
|
|
}
|
|
|
|
// MarshalJSON returns c as the JSON encoding of c.
|
|
func (c *Code) MarshalJSON() ([]byte, error) {
|
|
if c == nil {
|
|
return []byte("null"), nil
|
|
}
|
|
str, ok := codeToStr[*c]
|
|
if !ok {
|
|
return nil, fmt.Errorf("invalid code: %d", *c)
|
|
}
|
|
return []byte(fmt.Sprintf("%q", str)), nil
|
|
}
|