Skip to content

Commit

Permalink
tests: open telemetry
Browse files Browse the repository at this point in the history
* unit test must have its own package

Signed-off-by: Alex Aizman <[email protected]>
  • Loading branch information
alex-aizman committed Nov 20, 2024
1 parent 6d0da64 commit 19c5ccb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
3 changes: 3 additions & 0 deletions tracing/tracing_on.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ func Init(conf *cmn.TracingConf, snode *meta.Snode, exp any /* trace.SpanExporte
otel.SetTracerProvider(tp)
}

// used in tests only
func ForceFlush() { tp.ForceFlush(context.Background()) }

func Shutdown() {
if !IsEnabled() {
return
Expand Down
38 changes: 18 additions & 20 deletions tracing/tracing_internal_test.go → tracing/unit_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
/*
* Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.
*/
package tracing
package tracing_test

import (
"context"
"io"
"net/http"
"net/http/httptest"

"github.com/NVIDIA/aistore/cmn"
"github.com/NVIDIA/aistore/core/meta"
"github.com/NVIDIA/aistore/tracing"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
Expand Down Expand Up @@ -56,37 +56,36 @@ var _ = Describe("Tracing", func() {

Describe("Server", func() {
AfterEach(func() {
Shutdown()
tp = nil
tracing.Shutdown()
})
It("should export server trace when tracing enabled", func() {
Init(&cmn.TracingConf{
tracing.Init(&cmn.TracingConf{
ExporterEndpoint: "dummy",
Enabled: true,
SamplerProbability: 1.0,
}, dummySnode, tracetest.NewInMemoryExporter(), aisVersion)
Expect(IsEnabled()).To(BeTrue())
Expect(tracing.IsEnabled()).To(BeTrue())

server := httptest.NewServer(NewTraceableHandler(newTestHandler, "testendpoint"))
server := httptest.NewServer(tracing.NewTraceableHandler(newTestHandler, "testendpoint"))
defer server.Close()

_, err := http.Get(server.URL)
Expect(err).NotTo(HaveOccurred())

tp.ForceFlush(context.Background())
tracing.ForceFlush()

Expect(len(exporter.GetSpans())).To(BeEquivalentTo(1))
span := exporter.GetSpans()[0]
expectResourceAttrs(span.Resource.Attributes())
})

It("should do nothing when tracing disabled", func() {
Init(&cmn.TracingConf{
tracing.Init(&cmn.TracingConf{
Enabled: false,
}, dummySnode, tracetest.NewInMemoryExporter(), aisVersion)
Expect(IsEnabled()).To(BeFalse())
Expect(tracing.IsEnabled()).To(BeFalse())

server := httptest.NewServer(NewTraceableHandler(newTestHandler, "testendpoint"))
server := httptest.NewServer(tracing.NewTraceableHandler(newTestHandler, "testendpoint"))
defer server.Close()

_, err := http.Get(server.URL)
Expand All @@ -98,21 +97,20 @@ var _ = Describe("Tracing", func() {

Describe("Client", func() {
AfterEach(func() {
Shutdown()
tp = nil
tracing.Shutdown()
})
It("should export client trace when tracing enabled", func() {
Init(&cmn.TracingConf{
tracing.Init(&cmn.TracingConf{
ExporterEndpoint: "dummy",
Enabled: true,
SamplerProbability: 1.0,
}, dummySnode, tracetest.NewInMemoryExporter(), aisVersion)
Expect(IsEnabled()).To(BeTrue())
Expect(tracing.IsEnabled()).To(BeTrue())

server := httptest.NewServer(newTestHandler)
defer server.Close()

client := NewTraceableClient(http.DefaultClient)
client := tracing.NewTraceableClient(http.DefaultClient)
_, isOtelType := client.Transport.(*otelhttp.Transport)
Expect(isOtelType).To(BeTrue())

Expand All @@ -122,23 +120,23 @@ var _ = Describe("Tracing", func() {
_, err = io.ReadAll(resp.Body)
Expect(err).NotTo(HaveOccurred())

tp.ForceFlush(context.Background())
tracing.ForceFlush()

Expect(len(exporter.GetSpans())).To(BeEquivalentTo(1))
span := exporter.GetSpans()[0]
expectResourceAttrs(span.Resource.Attributes())
})

It("should do nothing when tracing disabled", func() {
Init(&cmn.TracingConf{
tracing.Init(&cmn.TracingConf{
Enabled: false,
}, dummySnode, tracetest.NewInMemoryExporter(), aisVersion)
Expect(IsEnabled()).To(BeFalse())
Expect(tracing.IsEnabled()).To(BeFalse())

server := httptest.NewServer(newTestHandler)
defer server.Close()

client := NewTraceableClient(http.DefaultClient)
client := tracing.NewTraceableClient(http.DefaultClient)

resp, err := client.Get(server.URL)
Expect(err).NotTo(HaveOccurred())
Expand Down

0 comments on commit 19c5ccb

Please sign in to comment.