Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Merge oc_span and oc_trace #137

Open
hauleth opened this issue Feb 11, 2019 · 4 comments
Open

Merge oc_span and oc_trace #137

hauleth opened this issue Feb 11, 2019 · 4 comments

Comments

@hauleth
Copy link
Contributor

hauleth commented Feb 11, 2019

All functions in oc_span are already present in the oc_trace. This will reduce public API of the library (good) but will slightly increase complexity of the oc_trace module (bad).

@tsloughter
Copy link
Member

oc_span is the functional interface to a span. oc_trace modifies an active span in the span store.

@essen
Copy link
Contributor

essen commented May 2, 2019

Both modules have an identical link/4 function oddly enough.

@hauleth
Copy link
Contributor Author

hauleth commented May 2, 2019

@tsloughter in that case oc_trace should land "under" the oc_span, for example as oc_span_trace or something like that. Otherwise it can be confusing to the users about the difference between trace and span.

@tsloughter
Copy link
Member

Yea, the extra link/4 is a mistake and can be removed from either of them.

I think we can fix this with docs in the modules to explain in oc_trace this is the module for interacting with your traces and that oc_span is really more of a private module, only to be used if you are writing something lower level, not instrumenting your own code.

Or actually marking it private so no docs are given for it.

Maybe there is also a better name for oc_trace but I don't think oc_span_trace is it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants