How to test/use correctly OpenCensus stats in an application using opencensus-go?

[slok]

Hi!

First of all, I want to let you know that I'm new to OpenCensus so maybe I'm taking a bad approach :)

I'm trying to add OpenCensus stats as part of instrumentation to one of the libraries I maintain.

I started getting familiar with some of the concepts and reading internal library code so I could create a OpenCensus Recorder on Kooper.

The problem is that I would like to inject an OpenCensus "registry", "recorder" or similar (the name doesn't matter) object, and (I think that) OpenCensus works at global level

opencensus-go/stats/internal/record.go

Line 12 in 904befa

var DefaultRecorder Recorder = nil

opencensus-go/stats/view/worker.go

Lines 28 to 32 in 904befa

	func init() {
	defaultWorker = newWorker()
	go defaultWorker.start()
	internal.DefaultRecorder = record
	}

opencensus-go/stats/view/worker.go

Lines 156 to 166 in 904befa

	func newWorker() *worker {
	return &worker{
	measures: make(map[string]*measureRef),
	views: make(map[string]*View),
	startTimes: make(map[*View]time.Time),
	timer: time.NewTicker(defaultReportingDuration),
	c: make(chan command),
	quit: make(chan bool),
	done: make(chan bool),
	}
	}

I've checked the tests of the worker and they work at the same package as the worker itself (go.opencensus.io/stats/view) so they can create new worker instances without problem, but outside the library that's not possible.

opencensus-go/stats/view/worker_test.go

Lines 579 to 583 in 30bf88b

	func restart() {
	defaultWorker.stop()
	defaultWorker = newWorker()
	go defaultWorker.start()
	}

So, in other words, I can't decouple my code correctly, inject the dependencies and make each test to be idempotent and independent without small hacks like reset functions. Appart from this, working in global context I can't make my tests run in parallel.

I'm missing something or there is an established approach when using and testing opencensus-go in other applications?

Is there out there any Go application or library using OpenCensus and tested so I can read the code as an example? I did not found.

Thank you for your time and OSS contributions!

[semistrict]

Yeah I have had the same complaint writing tests. I don't like all the global state we use, and there's a lot. We try to hide it all internally. Of course, this makes it very difficult to write tests against the library.

I have a few suggestions:

1. OpenCensus is really not ready to be depended on by other libraries without vendoring, since the APIs are changing rapidly. So in this case, you might want to wrap OpenCensus and have your wrapper be non-global and mock it out for testing.

2. Create new measures and view for every test (gets very ugly fast)

3. Help us make it better somehow - TBH I don't know what we should really do here. On the one hand I really don't want to require people to pass around a Recorder object. But maybe that's not so bad. I'm intrigued by the possibility of overriding the recording with a Context value, but that sounds like it might be an abuse of context.Context.

@rakyll @odeke-em your thoughts?

[cyriltovena]

Hello,

I'm currently integrating OpenCensus too and I would also like a way to test.

I have thought of two options :

• Make the recorder function public or allow to pass our own.
• Create a test exporter, though computed values could be a problem to assert.

WDYT ?

[cyriltovena]

In the end I'm testing with prometheus ouput using custom registry and the testutil package from prometheus.

My only issue was to flush the data before tests end, I hacked my way by unregistering all views (I saw a flush at that specific time :) ).

So #862 will also help testing.

[rghetia]

@Kuqd and @slok, we recently added Reader and IntervalReader. You can call ReadAndExport. Does that help?

[jkohen]

I'm not the original poster, but I just tried ReadAndExport and it's working for me without the sleep.