mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
7aa4190841
#### Description The last remaining part of #12676 is to implement the `outcome: failure` part of the Pipeline Component Telemetry RFC ([see here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/component-universal-telemetry.md#auto-instrumented-metrics)). This is done by introducing a `downstream` error wrapper struct, to distinguish between errors coming from the next component from errors bubbled from further downstream. #### Important note This PR implements things slightly differently from what the text of the RFC describes. If a pipeline contains components `A → B` and an error occurs in B, this PR records: - `otelcol.component.outcome = failure` in the `otelcol.*.consumed.*` metric for B - `otelcol.component.outcome = refused` in the `otelcol.*.produced.*` metric for A whereas the RFC would set both `outcome`s to `failure`. This is programmatically simpler — no need to have different behavior between the `obsconsumer` around the output of A and the one around the input of B — but more importantly, I think it is clearer for users as well: `outcome = failure` only occurs on metrics associated with the component where the failure actually occurred. This subtlety wasn't discussed in-depth in #11956 which introduced `outcome = refused`, so I took the liberty to make this change. If necessary, I can file another RFC amendment to match, or, if there are objections, implement the RFC as-is instead. #### Link to tracking issue Fixes #12676 #### Testing I've updated the existing tests in `obsconsumer` to expect a `downstream`-wrapped error to exit the `obsconsumer` layer. I may add more tests later. #### Documentation None. --------- Co-authored-by: Alex Boten <[email protected]> Co-authored-by: Pablo Baeyens <[email protected]>
39 lines
1.1 KiB
Go
39 lines
1.1 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package consumererror // import "go.opentelemetry.io/collector/consumer/consumererror"
|
|
|
|
import "errors"
|
|
|
|
type downstreamError struct {
|
|
inner error
|
|
}
|
|
|
|
var _ error = downstreamError{}
|
|
|
|
func (de downstreamError) Error() string {
|
|
return de.inner.Error()
|
|
}
|
|
|
|
func (de downstreamError) Unwrap() error {
|
|
return de.inner
|
|
}
|
|
|
|
// NewDownstream wraps an error to indicate that it is a downstream error, i.e. an
|
|
// error that does not come from the current component, but from one further downstream.
|
|
// This is used by pipeline instrumentation to determine whether an operation's outcome
|
|
// was an internal failure, or if it successfully produced data that was later refused.
|
|
// This wrapper is not intended to be used manually inside components.
|
|
func NewDownstream(err error) error {
|
|
return downstreamError{
|
|
inner: err,
|
|
}
|
|
}
|
|
|
|
// IsDownstream checks if an error was wrapped with the NewDownstream function,
|
|
// or if it contains one such error in its Unwrap() tree.
|
|
func IsDownstream(err error) bool {
|
|
var de downstreamError
|
|
return errors.As(err, &de)
|
|
}
|