Skip to content

Do not exceed ES _id length limit #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yurishkuro merged 7 commits into from
Jul 10, 2018
Merged

Do not exceed ES _id length limit #905

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6f43001
leave document _id generation to Eleasticsearch
tmszdmsk Jul 2, 2018
3489723
Calculate sha256 checksum for document _id for Elasticsearch.
harnash Jul 4, 2018
10fcf67
Using Hashable interface to calculate Elasticsearch ids
harnash Jul 5, 2018
762c739
Introduce Service::hashCode() to calculate Elasticsearch _id
harnash Jul 9, 2018
658cec6
Merge branch 'master' into 779-ES-autogenerate-id
harnash Jul 9, 2018
3d46c8a
Do not calculate Service hash in tests
harnash Jul 10, 2018
8e909f5
Merge branch 'master' into 779-ES-autogenerate-id
harnash Jul 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions plugin/storage/es/spanstore/service_operation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ package spanstore

import (
"context"
"fmt"
"time"

"github.com/jaegertracing/jaeger/model"
"github.com/pkg/errors"
"github.com/uber/jaeger-lib/metrics"
"go.uber.org/zap"
Expand Down Expand Up @@ -74,10 +74,11 @@ func (s *ServiceOperationStorage) Write(indexName string, jsonSpan *jModel.Span)
ServiceName: jsonSpan.Process.ServiceName,
OperationName: jsonSpan.OperationName,
}
serviceID := fmt.Sprintf("%s|%s", service.ServiceName, service.OperationName)
cacheKey := fmt.Sprintf("%s:%s", indexName, serviceID)

serviceHash, _ := model.HashCode(service)
cacheKey := string(serviceHash)
if !keyInCache(cacheKey, s.serviceCache) {
s.client.Index().Index(indexName).Type(serviceType).Id(serviceID).BodyJson(service).Add()
s.client.Index().Index(indexName).Type(serviceType).Id(cacheKey).BodyJson(service).Add()
writeCache(cacheKey, s.serviceCache)
}
}
Expand Down
21 changes: 19 additions & 2 deletions plugin/storage/es/spanstore/service_operation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/stretchr/testify/require"
"gopkg.in/olivere/elastic.v5"

"github.com/jaegertracing/jaeger/model"
jModel "github.com/jaegertracing/jaeger/model/json"
"github.com/jaegertracing/jaeger/pkg/es/mocks"
)
Expand All @@ -31,9 +32,17 @@ func TestWriteService(t *testing.T) {
indexService := &mocks.IndexService{}

indexName := "jaeger-1995-04-21"
service := Service{
ServiceName: "service",
OperationName: "operation",
}

serviceHash, err := model.HashCode(service)
Copy link
Copy Markdown
Member

@yurishkuro yurishkuro Jul 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this introduces unnecessary public method to Service type. Instead I would simply add something like this:

func (s Service) hashCode() string {
    h := fnv.New64a()
    h.Write(s.ServiceName)
    h.Write(s. OperationName)
    return fmt.Sprintf("%x", h.Sum64())
}

require.NoError(t, err)

indexService.On("Index", stringMatcher(indexName)).Return(indexService)
indexService.On("Type", stringMatcher(serviceType)).Return(indexService)
indexService.On("Id", stringMatcher("service|operation")).Return(indexService)
indexService.On("Id", stringMatcher(string(serviceHash))).Return(indexService)
indexService.On("BodyJson", mock.AnythingOfType("spanstore.Service")).Return(indexService)
indexService.On("Add")

Expand Down Expand Up @@ -64,9 +73,17 @@ func TestWriteServiceError(t *testing.T) {
indexService := &mocks.IndexService{}

indexName := "jaeger-1995-04-21"
service := Service{
ServiceName: "service",
OperationName: "operation",
}

serviceHash, err := model.HashCode(service)
require.NoError(t, err)

indexService.On("Index", stringMatcher(indexName)).Return(indexService)
indexService.On("Type", stringMatcher(serviceType)).Return(indexService)
indexService.On("Id", stringMatcher("service|operation")).Return(indexService)
indexService.On("Id", stringMatcher(string(serviceHash))).Return(indexService)
indexService.On("BodyJson", mock.AnythingOfType("spanstore.Service")).Return(indexService)
indexService.On("Add")

Expand Down
10 changes: 10 additions & 0 deletions plugin/storage/es/spanstore/writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ package spanstore

import (
"context"
"encoding/gob"
"io"
"strconv"
"strings"
"time"
Expand Down Expand Up @@ -73,6 +75,14 @@ type Span struct {
StartTimeMillis uint64 `json:"startTimeMillis"`
}

// Hash implements Hash from Hashable.
func (s Service) Hash(w io.Writer) (err error) {
// gob is not the most efficient way, but it ensures we don't miss any fields.
// See BenchmarkSpanHash in span_test.go
enc := gob.NewEncoder(w)
return enc.Encode(s)
}

// NewSpanWriter creates a new SpanWriter for use
func NewSpanWriter(
client es.Client,
Expand Down
9 changes: 8 additions & 1 deletion plugin/storage/es/spanstore/writer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,10 @@ func TestSpanWriter_WriteSpan(t *testing.T) {
},
StartTime: date,
}
service := Service{
ServiceName: "service",
OperationName: "operation",
}

spanIndexName := "jaeger-span-1995-04-21"
serviceIndexName := "jaeger-service-1995-04-21"
Expand Down Expand Up @@ -159,7 +163,10 @@ func TestSpanWriter_WriteSpan(t *testing.T) {
indexService.On("Type", stringMatcher(serviceType)).Return(indexServicePut)
indexService.On("Type", stringMatcher(spanType)).Return(indexSpanPut)

indexServicePut.On("Id", stringMatcher("service|operation")).Return(indexServicePut)
serviceHash, err := model.HashCode(service)
require.NoError(t, err)

indexServicePut.On("Id", stringMatcher(string(serviceHash))).Return(indexServicePut)
indexServicePut.On("BodyJson", mock.AnythingOfType("spanstore.Service")).Return(indexServicePut)
indexServicePut.On("Add")

Expand Down