mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
Roger CollandGitHub
cb679a452f
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Adds a `pcommon.Map` to the Event struct to represent additional metadata from the producer. These attributes can be interpreted by consumers, such as `Watcher` implementations like the healthcheckv2 extension. Since the long-term goal is to replace Event with a pdata.Log (OpenTelemetry Event), introducing attributes serves as an intermediary step. This allows for experimentation with subcomponents and more fine-grained events without immediately committing to a full migration. It extends the `NewEvent` constructor in a backward compatible approach with a new optional `...EventBuilderOption` parameter. The EventBuilderOption is a sealed interface which is implemented with new methods like `WithAttributes`. <!-- Issue number if applicable --> #### Link to tracking issue Fixes # https://github.com/open-telemetry/opentelemetry-collector/issues/13210 <!--Describe what testing was performed and which tests were added.--> #### Testing Constructor unit tests, calls to generate Events from the internal graph have not been modified. <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.-->
145 lines
3.2 KiB
Go
145 lines
3.2 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
package componentstatus
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/collector/component"
|
|
"go.opentelemetry.io/collector/pdata/pcommon"
|
|
)
|
|
|
|
func TestNewStatusEvent(t *testing.T) {
|
|
statuses := []Status{
|
|
StatusStarting,
|
|
StatusOK,
|
|
StatusRecoverableError,
|
|
StatusPermanentError,
|
|
StatusFatalError,
|
|
StatusStopping,
|
|
StatusStopped,
|
|
}
|
|
|
|
for _, status := range statuses {
|
|
t.Run(fmt.Sprintf("%s without error", status), func(t *testing.T) {
|
|
ev := NewEvent(status)
|
|
require.Equal(t, status, ev.Status())
|
|
require.NoError(t, ev.Err())
|
|
require.False(t, ev.Timestamp().IsZero())
|
|
require.Equal(t, pcommon.NewMap(), ev.Attributes())
|
|
})
|
|
t.Run(fmt.Sprintf("%s without error and attributes", status), func(t *testing.T) {
|
|
eventAttrs := pcommon.NewMap()
|
|
require.NoError(t, eventAttrs.FromRaw(map[string]any{"test": "a"}))
|
|
ev := NewEvent(status, WithAttributes(eventAttrs))
|
|
require.Equal(t, status, ev.Status())
|
|
require.NoError(t, ev.Err())
|
|
require.False(t, ev.Timestamp().IsZero())
|
|
require.Equal(t, eventAttrs, ev.Attributes())
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestStatusEventsWithError(t *testing.T) {
|
|
statusConstructorMap := map[Status]func(error) *Event{
|
|
StatusRecoverableError: NewRecoverableErrorEvent,
|
|
StatusPermanentError: NewPermanentErrorEvent,
|
|
StatusFatalError: NewFatalErrorEvent,
|
|
}
|
|
|
|
for status, newEvent := range statusConstructorMap {
|
|
t.Run(fmt.Sprintf("error status constructor for: %s", status), func(t *testing.T) {
|
|
ev := newEvent(assert.AnError)
|
|
require.Equal(t, status, ev.Status())
|
|
require.Equal(t, assert.AnError, ev.Err())
|
|
require.False(t, ev.Timestamp().IsZero())
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestStatusIsError(t *testing.T) {
|
|
for _, tc := range []struct {
|
|
status Status
|
|
isError bool
|
|
}{
|
|
{
|
|
status: StatusStarting,
|
|
isError: false,
|
|
},
|
|
{
|
|
status: StatusOK,
|
|
isError: false,
|
|
},
|
|
{
|
|
status: StatusRecoverableError,
|
|
isError: true,
|
|
},
|
|
{
|
|
status: StatusPermanentError,
|
|
isError: true,
|
|
},
|
|
{
|
|
status: StatusFatalError,
|
|
isError: true,
|
|
},
|
|
{
|
|
status: StatusStopping,
|
|
isError: false,
|
|
},
|
|
{
|
|
status: StatusStopped,
|
|
isError: false,
|
|
},
|
|
} {
|
|
name := fmt.Sprintf("StatusIsError(%s) is %t", tc.status, tc.isError)
|
|
t.Run(name, func(t *testing.T) {
|
|
assert.Equal(t, tc.isError, StatusIsError(tc.status))
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_ReportStatus(t *testing.T) {
|
|
t.Run("Reporter implemented", func(t *testing.T) {
|
|
r := &reporter{}
|
|
ReportStatus(r, NewEvent(StatusOK))
|
|
require.True(t, r.reportStatusCalled)
|
|
})
|
|
|
|
t.Run("Reporter not implemented", func(t *testing.T) {
|
|
h := &host{}
|
|
ReportStatus(h, NewEvent(StatusOK))
|
|
require.False(t, h.reportStatusCalled)
|
|
})
|
|
}
|
|
|
|
var (
|
|
_ = component.Host(nil)
|
|
_ = Reporter(nil)
|
|
)
|
|
|
|
type reporter struct {
|
|
reportStatusCalled bool
|
|
}
|
|
|
|
func (r *reporter) GetExtensions() map[component.ID]component.Component {
|
|
return nil
|
|
}
|
|
|
|
func (r *reporter) Report(_ *Event) {
|
|
r.reportStatusCalled = true
|
|
}
|
|
|
|
var _ = component.Host(nil)
|
|
|
|
type host struct {
|
|
reportStatusCalled bool
|
|
}
|
|
|
|
func (h *host) GetExtensions() map[component.ID]component.Component {
|
|
return nil
|
|
}
|