mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-01-01 22:09:57 +02:00
33699d242d
Adds support for the opentelemetry exceptions semantic conventions. In short, this has RecordError produce an exception event with exception attributes instead of using the error event and error attributes. While golang does not have exceptions, the spec itself does not differentiate between errors and exceptions for recording purposes. RecordError was kept as the method name, both for backwards compatibility and to reduce confusion (the method signature takes in a golang error object). The spec appears to allow this, as it suggests the method is optional and signature may reflect whatever is most appropriate for the language implementing it. It may seem non-intuitive to log an exception event from a method called RecordError, but it's beneficial to have consistent behavior across all opentelemetry SDKs. Downstream projects like the opentelemetry-collector can build off of the published API and not special case behaviors from individual languages.
40 lines
1.4 KiB
Go
40 lines
1.4 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 semconv
|
|
|
|
import "go.opentelemetry.io/otel/attribute"
|
|
|
|
// Semantic conventions for exception attribute keys.
|
|
const (
|
|
// The Go type containing the error or exception.
|
|
ExceptionTypeKey = attribute.Key("exception.type")
|
|
|
|
// The exception message.
|
|
ExceptionMessageKey = attribute.Key("exception.message")
|
|
|
|
// A stacktrace as a string. This most commonly will come from
|
|
// "runtime/debug".Stack.
|
|
ExceptionStacktraceKey = attribute.Key("exception.stacktrace")
|
|
|
|
// If the exception event is recorded at a point where it is known
|
|
// that the exception is escaping the scope of the span this
|
|
// attribute is set to true.
|
|
ExceptionEscapedKey = attribute.Key("exception.escaped")
|
|
)
|
|
|
|
const (
|
|
// ExceptionEventName is the name of the Span event representing an exception.
|
|
ExceptionEventName = "exception"
|
|
)
|