jaeger-php icon indicating copy to clipboard operation
jaeger-php copied to clipboard

Some API/documentation issues

Open yurishkuro opened this issue 5 years ago • 1 comments

initTracer

$tracer = $config->initTrace('example', '0.0.0.0:6831');
  • should be initTracer
  • The parameters look positional, is only UDP sender currently supported?

Close Trace(r)?

$config->setDisabled(true);

I am not sure what this does. Method does not have English comment.

Flush trace

$config->flush();

This method looks like it forces flushing of all spans from memory buffers - should it not be a method on the Tracer object then? Config is just a factory for the Tracer.

yurishkuro avatar May 07 '19 02:05 yurishkuro

  • The parameters look positional, is only UDP sender currently supported?

Yes, now only supported UDP.

  • I am not sure what this does. Method does not have English comment.

if set that true, will get NoopTracer object.

  • This method looks like it forces flushing of all spans from memory buffers - should it not be a method on the Tracer object then? Config is just a factory for the Tracer

Yes, I want to flush all spans in the end. but you can do this on the Tracer object too.

jukylin avatar May 07 '19 15:05 jukylin