otel: go.opentelemetry.io/otel/codes Index | Files

package codes

import "go.opentelemetry.io/otel/codes"

Package codes defines the canonical error codes used by OpenTelemetry.

This package is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

It conforms to [the OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#statuscanonicalcode).


Package Files

codes.go doc.go

type Code Uses

type Code uint32

Code is an 32-bit representation of a status state.

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

func (*Code) MarshalJSON Uses

func (c *Code) MarshalJSON() ([]byte, error)

MarshalJSON returns c as the JSON encoding of c.

func (Code) String Uses

func (c Code) String() string

String returns the Code as a string.

func (*Code) UnmarshalJSON Uses

func (c *Code) UnmarshalJSON(b []byte) error

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

Package codes imports 3 packages (graph) and is imported by 45 packages. Updated 2020-11-21. Refresh now. Tools for package owners.