codes

package

v1.25.0 Latest Latest Go to latest Published: Apr 5, 2024 License: Apache-2.0 Imports: 3 Imported by: 2,626

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/open-telemetry/opentelemetry-go

Links

Open Source Insights

README ¶

Codes

Documentation ¶

Overview ¶

Package codes defines the canonical error codes used by OpenTelemetry.

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

Index ¶

type Code

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Code ¶

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.
	//
	// NOTE: The error code in OTLP is 2.
	// The value of this enum is only relevant to the internals
	// of the Go SDK.
	Error Code = 1

	// Ok indicates operation has been validated by an Application developers
	// or Operator to have completed successfully, or contain no error.
	//
	// NOTE: The Ok code in OTLP is 1.
	// The value of this enum is only relevant to the internals
	// of the Go SDK.
	Ok Code = 2
)

func (*Code) MarshalJSON ¶ added in v0.13.0

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

MarshalJSON returns c as the JSON encoding of c.

func (Code) String ¶ added in v0.13.0

func (c Code) String() string

String returns the Code as a string.

func (*Code) UnmarshalJSON ¶ added in v0.13.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL