-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[logzioexporter] Remove dependency on jaeger dbmodel (#36972)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Copy the Jaeger plugin/storage/es/spanstore/dbmodel for logzioexporter, and remove the dependency. The dbmodel package in Jaeger will be internal from v1.65 (jaegertracing/jaeger#6428). <!-- Issue number (e.g. #36970) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes #36970 <!--Describe what testing was performed and which tests were added.--> #### Testing Covered by existing <!--Describe the documentation added.--> <!--Please delete paragraphs that you did not use before submitting.-->
- Loading branch information
Showing
8 changed files
with
459 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
component: logzioexporter | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Remove jaeger dbmodel dependency. | ||
|
||
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
issues: [36972] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | ||
|
||
# If your change doesn't affect end users or the exported elements of any package, | ||
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. | ||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [user] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// Copyright (c) 2019 The Jaeger Authors. | ||
// Copyright (c) 2018 Uber Technologies, Inc. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package logzioexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/logzioexporter" | ||
|
||
import ( | ||
"strings" | ||
|
||
"github.com/jaegertracing/jaeger/model" | ||
|
||
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/logzioexporter/internal/dbmodel" | ||
) | ||
|
||
// newFromDomain creates fromDomain used to convert model span to db span | ||
func newFromDomain(allTagsAsObject bool, tagKeysAsFields []string, tagDotReplacement string) fromDomain { | ||
tags := map[string]bool{} | ||
for _, k := range tagKeysAsFields { | ||
tags[k] = true | ||
} | ||
return fromDomain{allTagsAsFields: allTagsAsObject, tagKeysAsFields: tags, tagDotReplacement: tagDotReplacement} | ||
} | ||
|
||
// fromDomain is used to convert model span to db span | ||
type fromDomain struct { | ||
allTagsAsFields bool | ||
tagKeysAsFields map[string]bool | ||
tagDotReplacement string | ||
} | ||
|
||
// fromDomainEmbedProcess converts model.span into json.span format. | ||
// This format includes a ParentSpanID and an embedded process. | ||
func (fd fromDomain) fromDomainEmbedProcess(span *model.Span) *logzioSpan { | ||
return fd.convertSpanEmbedProcess(span) | ||
} | ||
|
||
func (fd fromDomain) convertSpanInternal(span *model.Span) logzioSpan { | ||
tags, tagsMap := fd.convertKeyValuesString(span.Tags) | ||
return logzioSpan{ | ||
TraceID: dbmodel.TraceID(span.TraceID.String()), | ||
SpanID: dbmodel.SpanID(span.SpanID.String()), | ||
Flags: uint32(span.Flags), | ||
OperationName: span.OperationName, | ||
StartTime: model.TimeAsEpochMicroseconds(span.StartTime), | ||
StartTimeMillis: model.TimeAsEpochMicroseconds(span.StartTime) / 1000, | ||
Duration: model.DurationAsMicroseconds(span.Duration), | ||
Tags: tags, | ||
Tag: tagsMap, | ||
Logs: fd.convertLogs(span.Logs), | ||
} | ||
} | ||
|
||
func (fd fromDomain) convertSpanEmbedProcess(span *model.Span) *logzioSpan { | ||
s := fd.convertSpanInternal(span) | ||
s.Process = fd.convertProcess(span.Process) | ||
s.References = fd.convertReferences(span) | ||
return &s | ||
} | ||
|
||
func (fd fromDomain) convertReferences(span *model.Span) []dbmodel.Reference { | ||
out := make([]dbmodel.Reference, 0, len(span.References)) | ||
for _, ref := range span.References { | ||
out = append(out, dbmodel.Reference{ | ||
RefType: fd.convertRefType(ref.RefType), | ||
TraceID: dbmodel.TraceID(ref.TraceID.String()), | ||
SpanID: dbmodel.SpanID(ref.SpanID.String()), | ||
}) | ||
} | ||
return out | ||
} | ||
|
||
func (fromDomain) convertRefType(refType model.SpanRefType) dbmodel.ReferenceType { | ||
if refType == model.FollowsFrom { | ||
return dbmodel.FollowsFrom | ||
} | ||
return dbmodel.ChildOf | ||
} | ||
|
||
func (fd fromDomain) convertKeyValuesString(keyValues model.KeyValues) ([]dbmodel.KeyValue, map[string]any) { | ||
var tagsMap map[string]any | ||
var kvs []dbmodel.KeyValue | ||
for _, kv := range keyValues { | ||
if kv.GetVType() != model.BinaryType && (fd.allTagsAsFields || fd.tagKeysAsFields[kv.Key]) { | ||
if tagsMap == nil { | ||
tagsMap = map[string]any{} | ||
} | ||
tagsMap[strings.ReplaceAll(kv.Key, ".", fd.tagDotReplacement)] = kv.Value() | ||
} else { | ||
kvs = append(kvs, convertKeyValue(kv)) | ||
} | ||
} | ||
if kvs == nil { | ||
kvs = make([]dbmodel.KeyValue, 0) | ||
} | ||
return kvs, tagsMap | ||
} | ||
|
||
func (fromDomain) convertLogs(logs []model.Log) []dbmodel.Log { | ||
out := make([]dbmodel.Log, len(logs)) | ||
for i, log := range logs { | ||
var kvs []dbmodel.KeyValue | ||
for _, kv := range log.Fields { | ||
kvs = append(kvs, convertKeyValue(kv)) | ||
} | ||
out[i] = dbmodel.Log{ | ||
Timestamp: model.TimeAsEpochMicroseconds(log.Timestamp), | ||
Fields: kvs, | ||
} | ||
} | ||
return out | ||
} | ||
|
||
func (fd fromDomain) convertProcess(process *model.Process) dbmodel.Process { | ||
tags, tagsMap := fd.convertKeyValuesString(process.Tags) | ||
return dbmodel.Process{ | ||
ServiceName: process.ServiceName, | ||
Tags: tags, | ||
Tag: tagsMap, | ||
} | ||
} | ||
|
||
func convertKeyValue(kv model.KeyValue) dbmodel.KeyValue { | ||
return dbmodel.KeyValue{ | ||
Key: kv.Key, | ||
Type: dbmodel.ValueType(strings.ToLower(kv.VType.String())), | ||
Value: kv.AsString(), | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// Copyright (c) 2019 The Jaeger Authors. | ||
// Copyright (c) 2018 Uber Technologies, Inc. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package logzioexporter | ||
|
||
import ( | ||
"bytes" | ||
"encoding/hex" | ||
"encoding/json" | ||
"fmt" | ||
"os" | ||
"testing" | ||
|
||
"github.com/gogo/protobuf/jsonpb" | ||
"github.com/jaegertracing/jaeger/model" | ||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
|
||
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/logzioexporter/internal/dbmodel" | ||
) | ||
|
||
func TestFromDomainEmbedProcess(t *testing.T) { | ||
domainStr, jsonStr := loadModel(t) | ||
|
||
var span model.Span | ||
require.NoError(t, jsonpb.Unmarshal(bytes.NewReader(domainStr), &span)) | ||
converter := newFromDomain(false, nil, ":") | ||
embeddedSpan := converter.fromDomainEmbedProcess(&span) | ||
|
||
var expectedSpan logzioSpan | ||
require.NoError(t, json.Unmarshal(jsonStr, &expectedSpan)) | ||
|
||
testJSONEncoding(t, jsonStr, embeddedSpan) | ||
} | ||
|
||
// Loads and returns domain model and JSON model. | ||
func loadModel(t *testing.T) ([]byte, []byte) { | ||
inStr, err := os.ReadFile("./testdata/span.json") | ||
require.NoError(t, err) | ||
outStr, err := os.ReadFile("./testdata/logziospan.json") | ||
require.NoError(t, err) | ||
return inStr, outStr | ||
} | ||
|
||
func testJSONEncoding(t *testing.T, expectedStr []byte, object any) { | ||
buf := &bytes.Buffer{} | ||
enc := json.NewEncoder(buf) | ||
enc.SetIndent("", " ") | ||
require.NoError(t, enc.Encode(object)) | ||
if !assert.Equal(t, string(expectedStr), buf.String()) { | ||
err := os.WriteFile("model-actual.json", buf.Bytes(), 0o600) | ||
require.NoError(t, err) | ||
} | ||
} | ||
|
||
func TestEmptyTags(t *testing.T) { | ||
tags := make([]model.KeyValue, 0) | ||
span := model.Span{Tags: tags, Process: &model.Process{Tags: tags}} | ||
converter := newFromDomain(false, nil, ":") | ||
dbSpan := converter.fromDomainEmbedProcess(&span) | ||
assert.Empty(t, dbSpan.Tags) | ||
assert.Empty(t, dbSpan.Tag) | ||
} | ||
|
||
func TestTagMap(t *testing.T) { | ||
tags := []model.KeyValue{ | ||
model.String("foo", "foo"), | ||
model.Bool("a", true), | ||
model.Int64("b.b", 1), | ||
} | ||
span := model.Span{Tags: tags, Process: &model.Process{Tags: tags}} | ||
converter := newFromDomain(false, []string{"a", "b.b", "b*"}, ":") | ||
dbSpan := converter.fromDomainEmbedProcess(&span) | ||
|
||
assert.Len(t, dbSpan.Tags, 1) | ||
assert.Equal(t, "foo", dbSpan.Tags[0].Key) | ||
assert.Len(t, dbSpan.Process.Tags, 1) | ||
assert.Equal(t, "foo", dbSpan.Process.Tags[0].Key) | ||
|
||
tagsMap := map[string]any{} | ||
tagsMap["a"] = true | ||
tagsMap["b:b"] = int64(1) | ||
assert.Equal(t, tagsMap, dbSpan.Tag) | ||
assert.Equal(t, tagsMap, dbSpan.Process.Tag) | ||
} | ||
|
||
func TestConvertKeyValueValue(t *testing.T) { | ||
longString := `Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues | ||
Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues | ||
Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues | ||
Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues | ||
Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues Bender Bending Rodrigues ` | ||
key := "key" | ||
tests := []struct { | ||
kv model.KeyValue | ||
expected dbmodel.KeyValue | ||
}{ | ||
{ | ||
kv: model.Bool(key, true), | ||
expected: dbmodel.KeyValue{Key: key, Value: "true", Type: "bool"}, | ||
}, | ||
{ | ||
kv: model.Bool(key, false), | ||
expected: dbmodel.KeyValue{Key: key, Value: "false", Type: "bool"}, | ||
}, | ||
{ | ||
kv: model.Int64(key, int64(1499)), | ||
expected: dbmodel.KeyValue{Key: key, Value: "1499", Type: "int64"}, | ||
}, | ||
{ | ||
kv: model.Float64(key, float64(15.66)), | ||
expected: dbmodel.KeyValue{Key: key, Value: "15.66", Type: "float64"}, | ||
}, | ||
{ | ||
kv: model.String(key, longString), | ||
expected: dbmodel.KeyValue{Key: key, Value: longString, Type: "string"}, | ||
}, | ||
{ | ||
kv: model.Binary(key, []byte(longString)), | ||
expected: dbmodel.KeyValue{Key: key, Value: hex.EncodeToString([]byte(longString)), Type: "binary"}, | ||
}, | ||
{ | ||
kv: model.KeyValue{VType: 1500, Key: key}, | ||
expected: dbmodel.KeyValue{Key: key, Value: "unknown type 1500", Type: "1500"}, | ||
}, | ||
} | ||
|
||
for _, test := range tests { | ||
t.Run(fmt.Sprintf("%s:%s", test.expected.Type, test.expected.Key), func(t *testing.T) { | ||
actual := convertKeyValue(test.kv) | ||
assert.Equal(t, test.expected, actual) | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// Copyright (c) 2019 The Jaeger Authors. | ||
// Copyright (c) 2018 Uber Technologies, Inc. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package dbmodel // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/logzioexporter/internal/dbmodel" | ||
|
||
// ReferenceType is the reference type of one span to another | ||
type ReferenceType string | ||
|
||
// TraceID is the shared trace ID of all spans in the trace. | ||
type TraceID string | ||
|
||
// SpanID is the id of a span | ||
type SpanID string | ||
|
||
// ValueType is the type of a value stored in KeyValue struct. | ||
type ValueType string | ||
|
||
const ( | ||
// ChildOf means a span is the child of another span | ||
ChildOf ReferenceType = "CHILD_OF" | ||
// FollowsFrom means a span follows from another span | ||
FollowsFrom ReferenceType = "FOLLOWS_FROM" | ||
|
||
// StringType indicates a string value stored in KeyValue | ||
StringType ValueType = "string" | ||
// BoolType indicates a Boolean value stored in KeyValue | ||
BoolType ValueType = "bool" | ||
// Int64Type indicates a 64bit signed integer value stored in KeyValue | ||
Int64Type ValueType = "int64" | ||
// Float64Type indicates a 64bit float value stored in KeyValue | ||
Float64Type ValueType = "float64" | ||
// BinaryType indicates an arbitrary byte array stored in KeyValue | ||
BinaryType ValueType = "binary" | ||
) | ||
|
||
// Reference is a reference from one span to another | ||
type Reference struct { | ||
RefType ReferenceType `json:"refType"` | ||
TraceID TraceID `json:"traceID"` | ||
SpanID SpanID `json:"spanID"` | ||
} | ||
|
||
// Process is the process emitting a set of spans | ||
type Process struct { | ||
ServiceName string `json:"serviceName"` | ||
Tags []KeyValue `json:"tags"` | ||
// Alternative representation of tags for better kibana support | ||
Tag map[string]any `json:"tag,omitempty"` | ||
} | ||
|
||
// Log is a log emitted in a span | ||
type Log struct { | ||
Timestamp uint64 `json:"timestamp"` | ||
Fields []KeyValue `json:"fields"` | ||
} | ||
|
||
// KeyValue is a key-value pair with typed value. | ||
type KeyValue struct { | ||
Key string `json:"key"` | ||
Type ValueType `json:"type,omitempty"` | ||
Value any `json:"value"` | ||
} | ||
|
||
// Service is the JSON struct for service:operation documents in ElasticSearch | ||
type Service struct { | ||
ServiceName string `json:"serviceName"` | ||
OperationName string `json:"operationName"` | ||
} |
Oops, something went wrong.