Renaming (#45)

* Rename samplers to match spec

* Rename Reporter -> Exporter

Author: chingor13

README.md

@@ -19,9 +19,9 @@ $ composer require opencensus/opencensus
 
 ```php
 use OpenCensus\Trace\RequestTracer;
-use OpenCensus\Trace\Reporter\EchoReporter;
+use OpenCensus\Trace\Exporter\EchoExporter;
 
-RequestTracer::start(new EchoReporter());
+RequestTracer::start(new EchoExporter());
 ```
 
 ### PHP Extension
@@ -42,21 +42,21 @@ extension=opencensus.so
 
 ### Reporting Traces
 
-The above sample uses the `EchoReporter` to dump trace results to the
+The above sample uses the `EchoExporter` to dump trace results to the
 bottom of the webpage.
 
-If you would like to provide your own reporter, create a class that implements `ReporterInterface`.
+If you would like to provide your own reporter, create a class that implements `ExporterInterface`.
 
 #### Currently implemented reporters
 
 | Class | Description |
 | ----- | ----------- |
-| [EchoReporter](src/Trace/Reporter/EchoReporter.php) | Output the collected spans to stdout |
-| [FileReporter](src/Trace/Reporter/FileReporter.php) | Output JSON encoded spans to a file |
-| [GoogleCloudReporter](src/Trace/Reporter/GoogleCloudReporter.php) | Report traces to Google Cloud Stackdriver Trace |
-| [LoggerReporter](src/Trace/Reporter/LoggerReporter.php) | Reporter JSON encoded spans to a PSR-3 logger |
-| [NullReporter](scr/Trace/Reporter/NullReporter.php) | No-op |
-| [ZipkinReporter](src/Trace/Reporter/ZipkinReporter.php) | Report collected spans to a Zipkin server |
+| [EchoExporter](src/Trace/Exporter/EchoExporter.php) | Output the collected spans to stdout |
+| [FileExporter](src/Trace/Exporter/FileExporter.php) | Output JSON encoded spans to a file |
+| [GoogleCloudExporter](src/Trace/Exporter/GoogleCloudExporter.php) | Report traces to Google Cloud Stackdriver Trace |
+| [LoggerExporter](src/Trace/Exporter/LoggerExporter.php) | Exporter JSON encoded spans to a PSR-3 logger |
+| [NullExporter](scr/Trace/Exporter/NullExporter.php) | No-op |
+| [ZipkinExporter](src/Trace/Exporter/ZipkinExporter.php) | Report collected spans to a Zipkin server |
 
 ### Sampling Rate
 
@@ -68,12 +68,12 @@ The preferred sampler is the `QpsSampler` (Queries Per Second). This sampler imp
 requires a PSR-6 cache implementation to function.
 
 ```php
-use OpenCensus\Trace\Reporter\EchoReporter;
+use OpenCensus\Trace\Exporter\EchoExporter;
 use OpenCensus\Trace\Sampler\QpsSampler;
 
 $cache = new SomeCacheImplementation();
 $sampler = new QpsSampler($cache, ['rate' => 0.1]); // sample 0.1 requests per second
-RequestTracer::start(new EchoReporter(), ['sampler' => $sampler]);
+RequestTracer::start(new EchoExporter(), ['sampler' => $sampler]);
 ```
 
 Please note: While required for the `QpsSampler`, a PSR-6 implementation is
@@ -83,24 +83,24 @@ dependency to fulfill this requirement. For PSR-6 implementations, please see th
 If the APCu extension is available (available on Google AppEngine Flexible Environment)
 and you include the cache/apcu-adapter composer package, we will set up the cache for you.
 
-You can also choose to use the `RandomSampler` which simply samples a flat
+You can also choose to use the `ProbabilitySampler` which simply samples a flat
 percentage of requests.
 
 #### Currently implemented samplers
 
 | Class | Description |
 | ----- | ----------- |
-| [AlwaysOffSampler](src/Trace/Sampler/AlwaysOffSampler.php) | Never trace any requests |
-| [AlwaysOnSampler](src/Trace/Sampler/AlwaysOnSampler.php) | Trace all requests |
+| [NeverSampleSampler](src/Trace/Sampler/NeverSampleSampler.php) | Never trace any requests |
+| [AlwaysSampleSampler](src/Trace/Sampler/AlwaysSampleSampler.php) | Trace all requests |
 | [QpsSampler](src/Trace/Sampler/QpsSampler.php) | Trace X requests per second. Requires a PSR-6 cache implementation |
-| [RandomSampler](src/Trace/Sampler/RandomSampler.php) | Trace X percent of requests. |
+| [ProbabilitySampler](src/Trace/Sampler/ProbabilitySampler.php) | Trace X percent of requests. |
 
 ```php
-use OpenCensus\Trace\Reporter\EchoReporter;
-use OpenCensus\Trace\Sampler\RandomSampler;
+use OpenCensus\Trace\Exporter\EchoExporter;
+use OpenCensus\Trace\Sampler\ProbabilitySampler;
 
-$sampler = new RandomSampler(0.1); // sample 10% of requests
-RequestTracer::start(new EchoReporter(), ['sampler' => $sampler]);
+$sampler = new ProbabilitySampler(0.1); // sample 10% of requests
+RequestTracer::start(new EchoExporter(), ['sampler' => $sampler]);
 ```
 
 If you would like to provide your own sampler, create a class that implements `SamplerInterface`.

src/Trace/Reporter/EchoReporter.php src/Trace/Exporter/EchoExporter.phpsrc/Trace/Reporter/EchoReporter.php renamed to src/Trace/Exporter/EchoExporter.php

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\Tracer\TracerInterface;
 
 /**
- * This implementation of the ReporterInterface uses `print_r` to output
+ * This implementation of the ExporterInterface uses `print_r` to output
  * the trace's representation to stdout.
  */
-class EchoReporter implements ReporterInterface
+class EchoExporter implements ExporterInterface
 {
     /**
      * Report the provided Trace to a backend.

src/Trace/Reporter/ReporterInterface.php src/Trace/Exporter/ExporterInterface.phpsrc/Trace/Reporter/ReporterInterface.php renamed to src/Trace/Exporter/ExporterInterface.php

@@ -15,14 +15,14 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\Tracer\TracerInterface;
 
 /**
- * The ReporterInterface allows you to swap out the Trace reporting mechanism
+ * The ExporterInterface allows you to swap out the Trace reporting mechanism
  */
-interface ReporterInterface
+interface ExporterInterface
 {
     /**
      * Report the provided Trace to a backend.

src/Trace/Reporter/FileReporter.php src/Trace/Exporter/FileExporter.phpsrc/Trace/Reporter/FileReporter.php renamed to src/Trace/Exporter/FileExporter.php

@@ -15,23 +15,23 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\Tracer\TracerInterface;
 
 /**
- * This implementation of the ReporterInterface appends a json
+ * This implementation of the ExporterInterface appends a json
  * representation of the trace to a file.
  */
-class FileReporter implements ReporterInterface
+class FileExporter implements ExporterInterface
 {
     /**
      * @var string The path to the output file.
      */
     private $filename;
 
     /**
-     * Create a new EchoReporter
+     * Create a new EchoExporter
      *
      * @param string $filename The path to the output file.
      */

…c/Trace/Reporter/GoogleCloudReporter.php …c/Trace/Exporter/GoogleCloudExporter.phpsrc/Trace/Reporter/GoogleCloudReporter.php renamed to src/Trace/Exporter/GoogleCloudExporter.php src/Trace/Reporter/GoogleCloudReporter.php renamed to src/Trace/Exporter/GoogleCloudExporter.php

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use Google\Cloud\Core\Batch\BatchRunner;
 use Google\Cloud\Core\Batch\BatchTrait;
@@ -25,15 +25,15 @@
 use OpenCensus\Trace\TraceSpan as OpenCensusTraceSpan;
 
 /**
- * This implementation of the ReporterInterface use the BatchRunner to provide
+ * This implementation of the ExporterInterface use the BatchRunner to provide
  * reporting of Traces and their TraceSpans to Google Cloud Stackdriver Trace.
  *
  * Example:
  * ```
  * use OpenCensus\Trace\RequestTracer;
- * use OpenCensus\Trace\Reporter\GoogleCloudReporter;
+ * use OpenCensus\Trace\Exporter\GoogleCloudExporter;
  *
- * $reporter = new GoogleCloudReporter([
+ * $reporter = new GoogleCloudExporter([
  *   'clientConfig' => [
  *      'projectId' => 'my-project'
  *   ]
@@ -48,9 +48,9 @@
  * Example:
  * ```
  * use OpenCensus\Trace\RequestTracer;
- * use OpenCensus\Trace\Reporter\GoogleCloudReporter;
+ * use OpenCensus\Trace\Exporter\GoogleCloudExporter;
  *
- * $reporter = new GoogleCloudReporter([
+ * $reporter = new GoogleCloudExporter([
  *   'async' => true,
  *   'clientConfig' => [
  *      'projectId' => 'my-project'
@@ -67,7 +67,7 @@
  *      incompatible ways. Please use with caution, and test thoroughly when
  *      upgrading.
  */
-class GoogleCloudReporter implements ReporterInterface
+class GoogleCloudExporter implements ExporterInterface
 {
     const VERSION = '0.1.0';
 
@@ -108,7 +108,7 @@ class GoogleCloudReporter implements ReporterInterface
     private $async;
 
     /**
-     * Create a TraceReporter that utilizes background batching.
+     * Create a TraceExporter that utilizes background batching.
      *
      * @param array $options [optional] {
      *     Configuration options.

src/Trace/Reporter/LoggerReporter.php src/Trace/Exporter/LoggerExporter.phpsrc/Trace/Reporter/LoggerReporter.php renamed to src/Trace/Exporter/LoggerExporter.php

@@ -15,16 +15,16 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\Tracer\TracerInterface;
 use Psr\Log\LoggerInterface;
 
 /**
- * This implementation of the ReporterInterface appends a json
+ * This implementation of the ExporterInterface appends a json
  * representation of the trace to a file.
  */
-class LoggerReporter implements ReporterInterface
+class LoggerExporter implements ExporterInterface
 {
     const DEFAULT_LOG_LEVEL = 'notice';
 
@@ -39,7 +39,7 @@ class LoggerReporter implements ReporterInterface
     private $level;
 
     /**
-     * Create a new LoggerReporter
+     * Create a new LoggerExporter
      *
      * @param LoggerInterface $logger The logger to write to.
      * @param string $level The logger level to write as. **Defaults to** `notice`.

src/Trace/Reporter/NullReporter.php src/Trace/Exporter/NullExporter.phpsrc/Trace/Reporter/NullReporter.php renamed to src/Trace/Exporter/NullExporter.php

@@ -15,14 +15,14 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\Tracer\TracerInterface;
 
 /**
- * This implementation of the ReporterInterface does nothing.
+ * This implementation of the ExporterInterface does nothing.
  */
-class NullReporter implements ReporterInterface
+class NullExporter implements ExporterInterface
 {
     /**
      * Does nothing.

src/Trace/Reporter/ZipkinReporter.php src/Trace/Exporter/ZipkinExporter.phpsrc/Trace/Reporter/ZipkinReporter.php renamed to src/Trace/Exporter/ZipkinExporter.php

@@ -15,16 +15,16 @@
  * limitations under the License.
  */
 
-namespace OpenCensus\Trace\Reporter;
+namespace OpenCensus\Trace\Exporter;
 
 use OpenCensus\Trace\Tracer\TracerInterface;
 use OpenCensus\Trace\TraceSpan;
 
 /**
- * This implementation of the ReporterInterface appends a json
+ * This implementation of the ExporterInterface appends a json
  * representation of the trace to a file.
  */
-class ZipkinReporter implements ReporterInterface
+class ZipkinExporter implements ExporterInterface
 {
     /**
      * @var string
@@ -47,7 +47,7 @@ class ZipkinReporter implements ReporterInterface
     private $url;
 
     /**
-     * Create a new ZipkinReporter
+     * Create a new ZipkinExporter
      *
      * @param string $name The name of this application
      * @param string $host The hostname of the Zipkin server

src/Trace/RequestHandler.php

@@ -17,7 +17,7 @@
 
 namespace OpenCensus\Trace;
 
-use OpenCensus\Trace\Reporter\ReporterInterface;
+use OpenCensus\Trace\Exporter\ExporterInterface;
 use OpenCensus\Trace\Sampler\SamplerInterface;
 use OpenCensus\Trace\TraceSpan;
 use OpenCensus\Trace\Tracer\ContextTracer;
@@ -38,7 +38,7 @@ class RequestHandler
     const DEFAULT_ROOT_SPAN_NAME = 'main';
 
     /**
-     * @var ReporterInterface The reported to use at the end of the request
+     * @var ExporterInterface The reported to use at the end of the request
      */
     private $reporter;
 
@@ -50,7 +50,7 @@ class RequestHandler
     /**
      * Create a new RequestHandler.
      *
-     * @param ReporterInterface $reporter How to report the trace at the end of the request
+     * @param ExporterInterface $reporter How to report the trace at the end of the request
      * @param SamplerInterface $sampler Which sampler to use for sampling requests
      * @param PropagatorInterface $propagator TraceContext propagator
      * @param array $options [optional] {
@@ -61,7 +61,7 @@ class RequestHandler
      * }
      */
     public function __construct(
-        ReporterInterface $reporter,
+        ExporterInterface $reporter,
         SamplerInterface $sampler,
         PropagatorInterface $propagator,
         array $options = []
@@ -104,7 +104,7 @@ public function __construct(
 
     /**
      * The function registered as the shutdown function. Cleans up the trace and
-     * reports using the provided ReporterInterface. Adds additional labels to
+     * reports using the provided ExporterInterface. Adds additional labels to
      * the root span detected from the response.
      */
     public function onExit()

src/Trace/RequestTracer.php

@@ -19,7 +19,7 @@
 
 use OpenCensus\Trace\Sampler\SamplerFactory;
 use OpenCensus\Trace\Sampler\SamplerInterface;
-use OpenCensus\Trace\Reporter\ReporterInterface;
+use OpenCensus\Trace\Exporter\ExporterInterface;
 use OpenCensus\Trace\Propagator\PropagatorInterface;
 use OpenCensus\Trace\Propagator\HttpHeaderPropagator;
 
@@ -33,9 +33,9 @@
  * Example:
  * ```
  * use OpenCensus\Trace\RequestTracer;
- * use OpenCensus\Trace\Reporter\EchoReporter;
+ * use OpenCensus\Trace\Exporter\EchoExporter;
  *
- * $reporter = new EchoReporter();
+ * $reporter = new EchoExporter();
  * RequestTracer::start($reporter);
  * ```
  *
@@ -110,7 +110,7 @@ class RequestTracer
      * Start a new trace session for this request. You should call this as early as
      * possible for the most accurate results.
      *
-     * @param ReporterInterface $reporter
+     * @param ExporterInterface $reporter
      * @param array $options {
      *      Configuration options. See
      *      {@see OpenCensus\Trace\TraceSpan::__construct()} for the other available options.
@@ -123,7 +123,7 @@ class RequestTracer
      * }
      * @return RequestHandler
      */
-    public static function start(ReporterInterface $reporter, array $options = [])
+    public static function start(ExporterInterface $reporter, array $options = [])
     {
         $samplerOptions = array_key_exists('sampler', $options) ? $options['sampler'] : [];
         unset($options['sampler']);