mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
Jade GuitonandGitHub
e0b4b19597
#### Description This PR splits the code handling component attribute injection, currently in `internal/telemetry` and `internal/telemetry/componentattribute`, into three parts: - the part meant to be called by components to drop unwanted injected attributes, which remains in `internal/telemetry`; - the part which handles copying Zap logs to an OTel LoggerProvider (where injected attributes are surfaced as instrumentation scope attributes), which is moved into `service/telemetry/otelconftelemetry`, since this "copying" behavior is specific to the otelconf-based telemetry provider; - the rest is moved into `service/internal/componentattribute`. The main goals of this split are: - to address #13842, by moving most dependencies of `componentattribute` into the service - to prepare for the availability of alternate telemetry providers. I also rewrote a lot of the attribute injection code along the way: - Instead of adding an unexported field in `TelemetrySettings` to store the current set of injected attributes, this set is now stored inside the provider wrappers (which was already partly the case). This allowed me to move the `TelemetrySettings` definition back into `component`, removing the dependency it had on `componentattribute`. - I completely changed the approach for injection in logs. Instead of a chain of custom core wrappers with a `withAttributeSet` method, injected attributes are now set through the standard `zapcore.Core.With` method. By introducing a custom `ObjectMarshaler`, we can make injected attributes act like regular Zap fields, while also allowing special handling in the otelzap wrapper core, which will set them as instrumentation scope attributes instead of log record attributes. If I'm not mistaken, this PR should have no externally-visible changes, so no changelog should be necessary. (Except maybe the `_ struct{}` in `TelemetrySettings`, but there was no changelog when we added those elsewhere) #### Link to tracking issue Updates #13842 #### Testing The large amounts of splitting and refactoring led me to abandon the existing tests, as they would be too hard to adapt. I wrote new tests for the code in `service/telemetry/otelconftelemetry` and `service/internal/componentattribute`, which hopefully should fill that gap appropriately.
198 lines
5.2 KiB
Go
198 lines
5.2 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package attribute_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/collector/component"
|
|
"go.opentelemetry.io/collector/internal/telemetry"
|
|
"go.opentelemetry.io/collector/pipeline"
|
|
"go.opentelemetry.io/collector/pipeline/xpipeline"
|
|
"go.opentelemetry.io/collector/service/internal/attribute"
|
|
)
|
|
|
|
var (
|
|
signals = []pipeline.Signal{
|
|
pipeline.SignalTraces,
|
|
pipeline.SignalMetrics,
|
|
pipeline.SignalLogs,
|
|
xpipeline.SignalProfiles,
|
|
}
|
|
|
|
cIDs = []component.ID{
|
|
component.MustNewID("foo"),
|
|
component.MustNewID("foo2"),
|
|
component.MustNewID("bar"),
|
|
}
|
|
|
|
pIDs = []pipeline.ID{
|
|
pipeline.NewID(pipeline.SignalTraces),
|
|
pipeline.NewIDWithName(pipeline.SignalTraces, "2"),
|
|
pipeline.NewID(pipeline.SignalMetrics),
|
|
pipeline.NewIDWithName(pipeline.SignalMetrics, "2"),
|
|
pipeline.NewID(pipeline.SignalLogs),
|
|
pipeline.NewIDWithName(pipeline.SignalLogs, "2"),
|
|
pipeline.NewID(xpipeline.SignalProfiles),
|
|
pipeline.NewIDWithName(xpipeline.SignalProfiles, "2"),
|
|
}
|
|
)
|
|
|
|
func TestReceiver(t *testing.T) {
|
|
for _, sig := range signals {
|
|
for _, id := range cIDs {
|
|
r := attribute.Receiver(sig, id)
|
|
componentKind, ok := r.Set().Value(telemetry.ComponentKindKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, "receiver", componentKind.AsString())
|
|
|
|
signal, ok := r.Set().Value(telemetry.SignalKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, sig.String(), signal.AsString())
|
|
|
|
componentID, ok := r.Set().Value(telemetry.ComponentIDKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, id.String(), componentID.AsString())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestProcessor(t *testing.T) {
|
|
for _, pID := range pIDs {
|
|
for _, id := range cIDs {
|
|
p := attribute.Processor(pID, id)
|
|
componentKind, ok := p.Set().Value(telemetry.ComponentKindKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, "processor", componentKind.AsString())
|
|
|
|
pipelineID, ok := p.Set().Value(telemetry.PipelineIDKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, pID.String(), pipelineID.AsString())
|
|
|
|
componentID, ok := p.Set().Value(telemetry.ComponentIDKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, id.String(), componentID.AsString())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestExporter(t *testing.T) {
|
|
for _, sig := range signals {
|
|
for _, id := range cIDs {
|
|
e := attribute.Exporter(sig, id)
|
|
componentKind, ok := e.Set().Value(telemetry.ComponentKindKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, "exporter", componentKind.AsString())
|
|
|
|
signal, ok := e.Set().Value(telemetry.SignalKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, sig.String(), signal.AsString())
|
|
|
|
componentID, ok := e.Set().Value(telemetry.ComponentIDKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, id.String(), componentID.AsString())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestConnector(t *testing.T) {
|
|
for _, exprSig := range signals {
|
|
for _, rcvrSig := range signals {
|
|
for _, id := range cIDs {
|
|
c := attribute.Connector(exprSig, rcvrSig, id)
|
|
componentKind, ok := c.Set().Value(telemetry.ComponentKindKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, "connector", componentKind.AsString())
|
|
|
|
signal, ok := c.Set().Value(telemetry.SignalKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, exprSig.String(), signal.AsString())
|
|
|
|
signalOutput, ok := c.Set().Value(telemetry.SignalOutputKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, rcvrSig.String(), signalOutput.AsString())
|
|
|
|
componentID, ok := c.Set().Value(telemetry.ComponentIDKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, id.String(), componentID.AsString())
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestExtension(t *testing.T) {
|
|
e := attribute.Extension(component.MustNewID("foo"))
|
|
componentKind, ok := e.Set().Value(telemetry.ComponentKindKey)
|
|
require.True(t, ok)
|
|
require.Equal(t, "extension", componentKind.AsString())
|
|
}
|
|
|
|
func TestSetEquality(t *testing.T) {
|
|
// The sets are created independently but should be exactly equivalent.
|
|
// We will ensure that corresponding elements are equal and that
|
|
// non-corresponding elements are not equal.
|
|
setI, setJ := createExampleSets(), createExampleSets()
|
|
for i, ei := range setI {
|
|
for j, ej := range setJ {
|
|
if i == j {
|
|
require.Equal(t, ei.ID(), ej.ID())
|
|
si, sj := ei.Set(), ej.Set()
|
|
require.True(t, si.Equals(sj))
|
|
} else {
|
|
require.NotEqual(t, ei.ID(), ej.ID())
|
|
si, sj := ei.Set(), ej.Set()
|
|
require.False(t, si.Equals(sj))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func createExampleSets() []attribute.Attributes {
|
|
sets := []attribute.Attributes{}
|
|
|
|
// Receiver examples.
|
|
for _, sig := range signals {
|
|
for _, id := range cIDs {
|
|
sets = append(sets, attribute.Receiver(sig, id))
|
|
}
|
|
}
|
|
|
|
// Processor examples.
|
|
for _, pID := range pIDs {
|
|
for _, cID := range cIDs {
|
|
sets = append(sets, attribute.Processor(pID, cID))
|
|
}
|
|
}
|
|
|
|
// Exporter examples.
|
|
for _, sig := range signals {
|
|
for _, id := range cIDs {
|
|
sets = append(sets, attribute.Exporter(sig, id))
|
|
}
|
|
}
|
|
|
|
// Connector examples.
|
|
for _, exprSig := range signals {
|
|
for _, rcvrSig := range signals {
|
|
for _, id := range cIDs {
|
|
sets = append(sets, attribute.Connector(exprSig, rcvrSig, id))
|
|
}
|
|
}
|
|
}
|
|
|
|
// Capabilities examples.
|
|
for _, pID := range pIDs {
|
|
sets = append(sets, attribute.Capabilities(pID))
|
|
}
|
|
|
|
// Fanout examples.
|
|
for _, pID := range pIDs {
|
|
sets = append(sets, attribute.Fanout(pID))
|
|
}
|
|
|
|
return sets
|
|
}
|