feat(es): Add otes package

.github/workflows/go.yml

@@ -52,6 +52,12 @@ jobs:
           KAFKA_LISTENERS: PLAINTEXT://0.0.0.0:9092
           KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
           KAFKA_CREATE_TOPICS: "count:1:1,uppercase:1:1,test:1:1"
+      elasticsearch:
+        image: elasticsearch:7.10.1
+        env:
+          discovery.type: single-node
+        ports:
+          - 9200:9200
     steps:
     - uses: actions/checkout@v2
 

README.md

@@ -180,7 +180,7 @@ That being said, let's redirect our attention to other goodies package core has
 * [Tutorial](https://github.com/DoNewsCode/core/blob/master/doc/tutorial.md)
 * [GoDoc](https://pkg.go.dev/github.com/DoNewsCode/core)
 * [Demo Project](https://github.com/DoNewsCode/skeleton)
-* [Contributing](https://github.com/DoNewsCode/core/blob/master/doc/contributing.markdown)
+* [Contributing](https://github.com/DoNewsCode/core/blob/master/doc/contributing.md)
 
 ## Design Principles
 

go.mod

@@ -34,6 +34,7 @@ require (
 	github.com/kr/pretty v0.2.1 // indirect
 	github.com/mitchellh/mapstructure v1.4.1
 	github.com/oklog/run v1.1.0
+	github.com/olivere/elastic/v7 v7.0.22
 	github.com/opentracing-contrib/go-gin v0.0.0-20201220185307-1dd2273433a4
 	github.com/opentracing-contrib/go-grpc v0.0.0-20210225150812-73cb765af46e
 	github.com/opentracing-contrib/go-stdlib v1.0.0

go.sum

@@ -41,6 +41,7 @@ github.com/aryann/difflib v0.0.0-20170710044230-e206f873d14a/go.mod h1:DAHtR1m6l
 github.com/aws/aws-lambda-go v1.13.3/go.mod h1:4UKl9IzQMoD+QF79YdCuzCwp8VbmG4VAQwij/eHl5CU=
 github.com/aws/aws-sdk-go v1.27.0/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
 github.com/aws/aws-sdk-go v1.34.28/go.mod h1:H7NKnBqNVzoTJpGfLrQkkD+ytBA93eiDYi/+8rV9s48=
+github.com/aws/aws-sdk-go v1.35.20/go.mod h1:tlPOdRjfxPBpNIwqDj61rmsnA85v9jc0Ps9+muhnW+k=
 github.com/aws/aws-sdk-go v1.37.16 h1:Q4YOP2s00NpB9wfmTDZArdcLRuG9ijbnoAwTW3ivleI=
 github.com/aws/aws-sdk-go v1.37.16/go.mod h1:hcU610XS61/+aQV88ixoOzUoG7v3b31pl2zKMmprdro=
 github.com/aws/aws-sdk-go-v2 v0.18.0/go.mod h1:JWVYvqSMppoMJC0x5wdwiImzgXTI9FuZwxzkQq9wy+g=
@@ -108,6 +109,7 @@ github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5Kwzbycv
 github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
 github.com/felixge/httpsnoop v1.0.1 h1:lvB5Jl89CsZtGIWuTcDM1E/vkVs49/Ml7JJe07l8SPQ=
 github.com/felixge/httpsnoop v1.0.1/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
+github.com/fortytw2/leaktest v1.3.0/go.mod h1:jDsjWgpAGjm2CA7WthBh/CdZYEPF31XHquHwclZch5g=
 github.com/franela/goblin v0.0.0-20200105215937-c9ffbefa60db/go.mod h1:7dvUGVsVBjqR7JHJk0brhHOZYGmfBYOrK0ZhYMEtBr4=
 github.com/franela/goreq v0.0.0-20171204163338-bcd34c9993f8/go.mod h1:ZhphrRTfi2rbfLwlschooIH4+wKKDR4Pdxhh+TRoA20=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
@@ -361,6 +363,8 @@ github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqx
 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
 github.com/jonboulle/clockwork v0.2.2 h1:UOGuzwb1PwsrDAObMuhUnj0p5ULPj8V/xJ7Kx9qUBdQ=
 github.com/jonboulle/clockwork v0.2.2/go.mod h1:Pkfl5aHPm1nk2H9h0bjmnJD/BcgbGXUBGnn1kMkgxc8=
+github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
+github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4=
 github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
 github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
@@ -405,6 +409,8 @@ github.com/lib/pq v1.3.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/lightstep/lightstep-tracer-common/golang/gogo v0.0.0-20190605223551-bc2310a04743/go.mod h1:qklhhLq1aX+mtWk9cPHPzaBjWImj5ULL6C7HFJtXQMM=
 github.com/lightstep/lightstep-tracer-go v0.18.1/go.mod h1:jlF1pusYV4pidLvZ+XD0UBX0ZE6WURAspgAczcDHrL4=
 github.com/magiconair/properties v1.8.1/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
+github.com/mailru/easyjson v0.7.6 h1:8yTIVnZgCoiM1TgqoeTl+LfU5Jg6/xL3QhGQnimLYnA=
+github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
 github.com/markbates/oncer v0.0.0-20181203154359-bf2de49a0be2/go.mod h1:Ld9puTsIW75CHf65OeIOkyKbteujpZVXDpWK6YGZbxE=
 github.com/markbates/safe v1.0.1/go.mod h1:nAqgmRi7cY2nqMc92/bSEeQA+R4OheNU2T1kNSCBdG0=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
@@ -467,6 +473,10 @@ github.com/oklog/run v1.1.0 h1:GEenZ1cK0+q0+wsJew9qUg/DyD8k3JzYsZAi5gYi2mA=
 github.com/oklog/run v1.1.0/go.mod h1:sVPdnTZT1zYwAJeCMu2Th4T21pA3FPOQRfWjQlk7DVU=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
 github.com/olekukonko/tablewriter v0.0.0-20170122224234-a0225b3f23b5/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo=
+github.com/olivere/elastic v1.0.1 h1:UeafjZg+TifCVPhCJNPof0pUHig6vbXuJEbC/A+Ouo0=
+github.com/olivere/elastic v6.2.35+incompatible h1:MMklYDy2ySi01s123CB2WLBuDMzFX4qhFcA5tKWJPgM=
+github.com/olivere/elastic/v7 v7.0.22 h1:esBA6JJwvYgfms0EVlH7Z+9J4oQ/WUADF2y/nCNDw7s=
+github.com/olivere/elastic/v7 v7.0.22/go.mod h1:VDexNy9NjmtAkrjNoI7tImv7FR4tf5zUA3ickqu5Pc8=
 github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk=
@@ -578,7 +588,10 @@ github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrf
 github.com/sirupsen/logrus v1.7.0 h1:ShrD1U9pZB12TX0cVy0DtePoCH97K8EtX+mg7ZARUtM=
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
+github.com/smartystreets/assertions v1.1.1/go.mod h1:tcbTF8ujkAEcZ8TElKY+i30BzYlVhC/LOxJk7iOWnoo=
+github.com/smartystreets/go-aws-auth v0.0.0-20180515143844-0c1422d1fdb9/go.mod h1:SnhjPscd9TpLiy1LpzGSKh3bXCfxxXuqd9xmQJy3slM=
 github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
+github.com/smartystreets/gunit v1.4.2/go.mod h1:ZjM1ozSIMJlAz/ay4SG8PeKF00ckUp+zMHZXV9/bvak=
 github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
 github.com/soheilhy/cmux v0.1.5-0.20210205191134-5ec6847320e5 h1:GJTW+uNMIV1RKwox+T4aN0/sQlYRg78uHZf2H0aBcDw=
 github.com/soheilhy/cmux v0.1.5-0.20210205191134-5ec6847320e5/go.mod h1:T7TcVDs9LWfQgPlPsdngu6I6QIoyIFZDDC6sNE1GqG0=
@@ -649,6 +662,7 @@ go.opencensus.io v0.20.2/go.mod h1:6WKK9ahsWS3RSO+PY9ZHZUfv2irvY6gN279GOPZjmmk=
 go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
 go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8=
 go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
+go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk=
 go.opentelemetry.io/otel v0.17.0 h1:6MKOu8WY4hmfpQ4oQn34u6rYhnf2sWf1LXYO/UFm71U=
 go.opentelemetry.io/otel v0.17.0/go.mod h1:Oqtdxmf7UtEvL037ohlgnaYa1h7GtMh0NcSd9eqkC9s=
 go.opentelemetry.io/otel/metric v0.17.0 h1:t+5EioN8YFXQ2EH+1j6FHCKMUj+57zIDSnSGr/mWuug=

otes/doc.go

@@ -0,0 +1,39 @@
+/*
+Package otes provides es client with opentracing.
+For documentation about es usage, see https://github.com/olivere/elastic
+
+Integration
+
+package otes exports the configuration in the following format:
+
+	es:
+	  default:
+        "url": "http://localhost:9200"
+		"index":       "",
+		"username":    "",
+		"password":    "",
+		"shards":      0,
+		"replicas":    0,
+		"sniff":       false,
+		"healthCheck": false,
+
+Add the es dependency to core:
+
+	var c *core.C = core.New()
+	c.Provide(otes.Providers())
+
+Then you can invoke etcd from the application.
+
+	c.Invoke(func(client *elastic.Client) {
+		// Do something with es
+	})
+
+Sometimes there are valid reasons to connect to more than one es server. Inject
+otes.Maker to factory a *elastic.Client with a specific configuration entry.
+
+	c.Invoke(function(maker otes.Maker) {
+		client, err := maker.Make("default")
+		// do something with client
+	})
+*/
+package otes

otes/example_test.go

@@ -0,0 +1,22 @@
+// +build integration
+
+package otes_test
+
+import (
+	"fmt"
+	"github.com/DoNewsCode/core"
+	"github.com/DoNewsCode/core/otes"
+	"github.com/olivere/elastic/v7"
+)
+
+func Example() {
+	c := core.New(core.WithInline("log.level", "none"))
+	c.ProvideEssentials()
+	c.Provide(otes.Providers())
+	c.Invoke(func(esClient *elastic.Client) {
+		running := esClient.IsRunning()
+		fmt.Println(running)
+	})
+	// Output:
+	// true
+}

otes/hook.go

@@ -0,0 +1,84 @@
+package otes
+
+import (
+	"net/http"
+	"strconv"
+
+	"github.com/opentracing/opentracing-go"
+	"github.com/opentracing/opentracing-go/ext"
+)
+// hook is borrowed from https://github.com/olivere/elastic/tree/release-branch.v7/trace/opentracing
+// under MIT license: https://github.com/olivere/elastic/blob/release-branch.v7/LICENSE
+
+// Transport for tracing Elastic operations.
+type Transport struct {
+	rt     http.RoundTripper
+	tracer opentracing.Tracer
+}
+
+// Option signature for specifying options, e.g. WithRoundTripper.
+type Option func(t *Transport)
+
+// WithRoundTripper specifies the http.RoundTripper to call
+// next after this transport. If it is nil (default), the
+// transport will use http.DefaultTransport.
+func WithRoundTripper(rt http.RoundTripper) Option {
+	return func(t *Transport) {
+		t.rt = rt
+	}
+}
+
+// WithTracer specifies the opentracing.Tracer to call
+// this transport.
+func WithTracer(tracer opentracing.Tracer) Option {
+	return func(t *Transport) {
+		t.tracer = tracer
+	}
+}
+
+// NewTransport specifies a transport that will trace Elastic
+// and report back via OpenTracing.
+func NewTransport(opts ...Option) *Transport {
+	t := &Transport{}
+	for _, o := range opts {
+		o(t)
+	}
+	return t
+}
+
+// RoundTrip captures the request and starts an OpenTracing span
+// for Elastic PerformRequest operation.
+func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error) {
+	span, ctx := opentracing.StartSpanFromContext(req.Context(), "es.query")
+	req = req.WithContext(ctx)
+	defer span.Finish()
+
+	ext.Component.Set(span, "github.com/olivere/elastic/v7")
+	ext.HTTPUrl.Set(span, req.URL.String())
+	ext.HTTPMethod.Set(span, req.Method)
+	ext.PeerHostname.Set(span, req.URL.Hostname())
+	ext.PeerPort.Set(span, toUint16(req.URL.Port()))
+
+	var (
+		resp *http.Response
+		err  error
+	)
+	if t.rt != nil {
+		resp, err = t.rt.RoundTrip(req)
+	} else {
+		resp, err = http.DefaultTransport.RoundTrip(req)
+	}
+	if err != nil {
+		ext.Error.Set(span, true)
+	}
+	if resp != nil {
+		ext.HTTPStatusCode.Set(span, uint16(resp.StatusCode))
+	}
+
+	return resp, err
+}
+
+func toUint16(s string) uint16 {
+	v, _ := strconv.ParseUint(s, 10, 16)
+	return uint16(v)
+}

otes/log.go

@@ -0,0 +1,39 @@
+package otes
+
+import (
+	"fmt"
+	"github.com/go-kit/kit/log"
+	"github.com/go-kit/kit/log/level"
+)
+
+//LogAdapter is an adapter between kitlog and es Logger interface
+
+//info logs informational messages
+type esInfoLogAdapter struct {
+	logger log.Logger
+}
+
+// Printf implements elastic.Logger
+func (l esInfoLogAdapter) Printf(msg string, v ...interface{}) {
+	level.Info(l.logger).Log("msg", fmt.Sprintf(msg, v...))
+}
+
+//error logs to the error log
+type esErrorLogAdapter struct {
+	logger log.Logger
+}
+
+// Printf implements elastic.Logger
+func (l esErrorLogAdapter) Printf(msg string, v ...interface{}) {
+	level.Error(l.logger).Log("msg", fmt.Sprintf(msg, v...))
+}
+
+//trace log for debugging
+type esTraceLogAdapter struct {
+	logger log.Logger
+}
+
+// Printf implements elastic.Logger
+func (l esTraceLogAdapter) Printf(msg string, v ...interface{}) {
+	level.Debug(l.logger).Log("msg", fmt.Sprintf(msg, v...))
+}