Clarify nature of Codes values w.r.t. OTLP (#3386)

* Clarify nature of Codes values w.r.t. OTLP * Update codes/codes.go Co-authored-by: Damien Mathieu <[email protected]> * go eff em tee dash ehs Co-authored-by: Damien Mathieu <[email protected]> Co-authored-by: Tyler Yahn <[email protected]>
open-telemetry · Oct 28, 2022 · 3b9862a · 3b9862a
1 parent 797e337
commit 3b9862a
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/codes/codes.go b/codes/codes.go
@@ -23,10 +23,20 @@ import (
 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
 
 	maxCode = 3