Index | OpenCensus PHP API

A

Context::attach() — Method in class Context: Attaches this context, thus entering a new scope within which this context is current(). The previously current context is returned.
Aggregation — Class in namespace OpenCensus\Stats\View: Aggregation represents a data aggregation method.
Annotation — Class in namespace OpenCensus\Trace: A class that represents an Annotation resource.
AttributeTrait — Class in namespace OpenCensus\Trace
AttributeTrait::addAttributes() — Method in class AttributeTrait: Attach attributes to this object.
AttributeTrait::addAttribute() — Method in class AttributeTrait: Attach a single attribute to this object.
AttributeTrait::attributes() — Method in class AttributeTrait: Return the list of attributes for this object.
NullEventHandler::attributeAdded() — Method in class NullEventHandler: Triggers when an attribute is added to a span.
SpanEventHandlerInterface::attributeAdded() — Method in class SpanEventHandlerInterface: Triggers when an attribute is added to a span.
RequestHandler::addAttribute() — Method in class RequestHandler: Add an attribute to the provided Span
RequestHandler::addAnnotation() — Method in class RequestHandler: Add an annotation to the provided Span
RequestHandler::addLink() — Method in class RequestHandler: Add a link to the provided Span
RequestHandler::addMessageEvent() — Method in class RequestHandler: Add an message event to the provided Span
RequestHandler::addCommonRequestAttributes() — Method in class RequestHandler
AlwaysSampleSampler — Class in namespace OpenCensus\Trace\Sampler: This implementation of the SamplerInterface always returns false. Use this sampler to attempt to trace all requests. You may be throttled by the server.
Span::attach() — Method in class Span: Mark this span as attached.
Span::attached() — Method in class Span: Returns whether or not this span has been attached.
Span::addAttribute() — Method in class Span: Add an attribute to this span.
Span::addTimeEvents() — Method in class Span: Add time events to this span.
Span::addTimeEvent() — Method in class Span: Add a time event to this span.
Span::addLinks() — Method in class Span: Add links to this span.
Span::addLink() — Method in class Span: Add a link to this span.
SpanData::attributes() — Method in class SpanData: Return the attributes for this span.
Tracer::addAttribute() — Method in class Tracer: Add an attribute to the provided Span
Tracer::addAnnotation() — Method in class Tracer: Add an annotation to the provided Span
Tracer::addLink() — Method in class Tracer: Add a link to the provided Span
Tracer::addMessageEvent() — Method in class Tracer: Add an message event to the provided Span
ContextTracer::addAttribute() — Method in class ContextTracer: Add an attribute to the provided Span
ContextTracer::addAnnotation() — Method in class ContextTracer: Add an annotation to the provided Span
ContextTracer::addLink() — Method in class ContextTracer: Add a link to the provided Span
ContextTracer::addMessageEvent() — Method in class ContextTracer: Add an message event to the provided Span
ExtensionTracer::addAttribute() — Method in class ExtensionTracer: Add an attribute to the provided Span
ExtensionTracer::addAnnotation() — Method in class ExtensionTracer: Add an annotation to the provided Span
ExtensionTracer::addLink() — Method in class ExtensionTracer: Add a link to the provided Span
ExtensionTracer::addMessageEvent() — Method in class ExtensionTracer: Add an message event to the provided Span
ExtensionTracer::attributeAdded() — Method in class ExtensionTracer: Triggers when an attribute is added to a span.
NullTracer::addAttribute() — Method in class NullTracer: Add an attribute to the provided Span
NullTracer::addAnnotation() — Method in class NullTracer: Add an annotation to the provided Span
NullTracer::addLink() — Method in class NullTracer: Add a link to the provided Span
NullTracer::addMessageEvent() — Method in class NullTracer: Add an message event to the provided Span
TracerInterface::addAttribute() — Method in class TracerInterface: Add an attribute to the provided Span
TracerInterface::addAnnotation() — Method in class TracerInterface: Add an annotation to the provided Span
TracerInterface::addLink() — Method in class TracerInterface: Add a link to the provided Span
TracerInterface::addMessageEvent() — Method in class TracerInterface: Add an message event to the provided Span

B

Context::background() — Method in class Context: Returns an empty context.
Binary — Class in namespace OpenCensus\Tags\Codec: This class implements the (de)serialization of TagContext using the binary wire format.
BinaryFormatter — Class in namespace OpenCensus\Trace\Propagator: This propagator contains the method for serializaing and deserializing SpanContext over a binary format.

C

Context — Class in namespace OpenCensus\Core: This class is an implementation of a generic context.
Context::current() — Method in class Context: Returns the context associated with the current scope, will never return null.
DaemonClient::createMeasure() — Method in class DaemonClient: Register a new Measure.
Scope::close() — Method in class Scope: Close and clean up the scope. Runs the initial callback provided.
ExporterInterface::createMeasure() — Method in class ExporterInterface: Register a new Measure.
NoopExporter::createMeasure() — Method in class NoopExporter: Register a new Measure.
FloatMeasure::create() — Method in class FloatMeasure: Constructs a new FloatMeasure.
IntMeasure::create() — Method in class IntMeasure: Constructs a new IntMeasure.
Aggregation::count() — Method in class Aggregation: Returns a new Count Aggregation
TagKey::create() — Method in class TagKey: Constructs a TagKey with the given name.
TagValue::create() — Method in class TagValue: Constructs a TagValue with the given string payload.
Curl — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting curl requests using the opencensus extension.
MessageEvent::compressedSize() — Method in class MessageEvent: Return the compressed size of this message event.
CloudTraceFormatter — Class in namespace OpenCensus\Trace\Propagator: This format using a human readable string encoding to propagate SpanContext.
Status::code() — Method in class Status: Returns the status code.
ContextTracer — Class in namespace OpenCensus\Trace\Tracer: This implementation of the TracerInterface manages your trace context throughout the request. It maintains a stack of Span records that are currently open allowing you to know the current context at any moment.

D

Context::detach() — Method in class Context: Reverses an attach(), restoring the previous context and exiting the current scope.
DaemonClient — Class in namespace OpenCensus\Core: This class is a client to the OpenCensus PHP Daemon application.
$Measure#description — Property in class Measure: Holds our measure's human readable description.
Aggregation::distribution() — Method in class Aggregation: Returns a new Distribution Aggregation with the provided Bucket Boundaries.
Binary::decode() — Method in class Binary: Decode the provided TagContext from the binary wire format.
TagContext::delete() — Method in class TagContext: Deletes Tag from TagContext identified by its TagKey.
Annotation::description() — Method in class Annotation: Return the description of this annotation.
DateFormatTrait — Class in namespace OpenCensus\Trace: Trait which provides helper methods for converting DateTime input formats.
Doctrine — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting the Doctrine ORM queries using the opencensus extension.
BinaryFormatter::deserialize() — Method in class BinaryFormatter: Generate a SpanContext object from the Trace Context header
CloudTraceFormatter::deserialize() — Method in class CloudTraceFormatter: Generate a SpanContext object from the Trace Context header
FormatterInterface::deserialize() — Method in class FormatterInterface: Generate a SpanContext object from the Trace Context header
TraceContextFormatter::deserialize() — Method in class TraceContextFormatter: Generate a SpanContext object from the Trace Context header
VarintTrait::decodeUnsigned() — Method in class VarintTrait: Varint decode an unsigned integer.
VarintTrait::decodeSigned() — Method in class VarintTrait: Varint decode a signed integer.

E

DaemonClient::export() — Method in class DaemonClient: Export the provided SpanData to a backend.
ExporterInterface — Class in namespace OpenCensus\Stats\Exporter: The ExporterInterface allows you to swap out the Stats reporting mechanism.
Binary::encode() — Method in class Binary: Encode the provided TagContext to our binary wire format.
TagContext::empty() — Method in class TagContext: Returns an empty YagContext object.
EchoExporter — Class in namespace OpenCensus\Trace\Exporter: This implementation of the ExporterInterface uses print_r to output the trace's representation to stdout.
EchoExporter::export() — Method in class EchoExporter: Report the provided Trace to a backend.
ExporterInterface — Class in namespace OpenCensus\Trace\Exporter: The ExporterInterface allows you to swap out the Trace reporting mechanism
ExporterInterface::export() — Method in class ExporterInterface: Export the provided SpanData to a backend.
FileExporter::export() — Method in class FileExporter: Report the provided SpanData to a file in json format.
LoggerExporter::export() — Method in class LoggerExporter: Report the provided Trace to a backend.
NullExporter::export() — Method in class NullExporter: Does nothing.
OneLineEchoExporter::export() — Method in class OneLineEchoExporter: Report the provided Trace to a backend.
Eloquent — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting the Eloquent ORM queries using the opencensus extension.
EventSubscriber — Class in namespace OpenCensus\Trace\Integrations\Guzzle: This class handles integration with GuzzleHttp 5. Attaching this EventSubscriber to your Guzzle client, will enable distrubted tracing by passing along the trace context header and will also create trace spans for all outgoing requests.
GrpcMetadataPropagator::extract() — Method in class GrpcMetadataPropagator: Generate a SpanContext object from the all the HTTP headers
HttpHeaderPropagator::extract() — Method in class HttpHeaderPropagator: Generate a SpanContext object from the all the HTTP headers
PropagatorInterface::extract() — Method in class PropagatorInterface: Extract the SpanContext from some container
SpanContext::enabled() — Method in class SpanContext: Whether or not the request is being traced.
SpanData::endTime() — Method in class SpanData: Retrieve the end time for this span.
ContextTracer::enabled() — Method in class ContextTracer: Whether or not this tracer is enabled.
ExtensionTracer — Class in namespace OpenCensus\Trace\Tracer: This implementation of the TracerInterface utilizes the opencensus extension to manage span context. The opencensus extension augments user created spans and adds automatic tracing to several commonly desired events.
ExtensionTracer::enabled() — Method in class ExtensionTracer: Whether or not this tracer is enabled.
NullTracer::enabled() — Method in class NullTracer: Whether or not this tracer is enabled.
TracerInterface::enabled() — Method in class TracerInterface: Whether or not this tracer is enabled.
VarintTrait::encodeUnsigned() — Method in class VarintTrait: Varint encode as unsigned integer.
VarintTrait::encodeSigned() — Method in class VarintTrait: Varint encode as signed integer.

F

FloatMeasure — Class in namespace OpenCensus\Stats: FloatMeasure is a Measure for Float values.
TagContext::fromContext() — Method in class TagContext: Extract a TagContext from the provided Context object.
FileExporter — Class in namespace OpenCensus\Trace\Exporter: This implementation of the ExporterInterface appends a JSON representation of the trace to a file.
FormatterInterface — Class in namespace OpenCensus\Trace\Propagator: This interface lets us define serialization strategies for SpanContext.
GrpcMetadataPropagator::formatter() — Method in class GrpcMetadataPropagator: Fetch the formatter for propagating the SpanContext
HttpHeaderPropagator::formatter() — Method in class HttpHeaderPropagator: Returns the current formatter
PropagatorInterface::formatter() — Method in class PropagatorInterface: Fetch the formatter for propagating the SpanContext
SpanContext::fromHeader() — Method in class SpanContext: Whether or not this context was detected from a request header.

G

Measure::getName() — Method in class Measure: Name returns the name of this measure.
Measure::getDescription() — Method in class Measure: Discription returns the human-readable description of this measure.
Measure::getUnit() — Method in class Measure: Unit returns the units for the values this measure takes on.
Measurement::getValue() — Method in class Measurement: Retrieves the value of the Measurement.
Measurement::getMeasure() — Method in class Measurement: Retrieves the Measure this measurement applies to.
Stats::getInstance() — Method in class Stats: Retrieve Stats instance.
Stats::getExporter() — Method in class Stats: Retrieve our ExporterInterface.
Aggregation::getType() — Method in class Aggregation: Returns the type of the aggregation.
Aggregation::getBucketBoundaries() — Method in class Aggregation: Returns the bucket boundaries of the Distribution Aggregation.
View::getName() — Method in class View: Retrieves the name of the view.
View::getDescription() — Method in class View: Retrieves the description of the view.
View::getTagKeys() — Method in class View: Retrieves the TagKeys used by the view.
View::getMeasure() — Method in class View: Return the Measure this View aggregates.
View::getAggregation() — Method in class View: Returns the Aggregation of the View.
Tag::getKey() — Method in class Tag: Returns the TagKey.
Tag::getValue() — Method in class Tag: Returns the TagValue.
TagKey::getName() — Method in class TagKey: Returns the name of the TagKey.
TagValue::getValue() — Method in class TagValue: Returns the payload of the TagValue.
Grpc — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting grpc requests using the opencensus extension.
EventSubscriber::getEvents() — Method in class EventSubscriber: Returns an array of event names this subscriber wants to listen to.
GrpcMetadataPropagator — Class in namespace OpenCensus\Trace\Propagator: This propagator contains the logic for propagating SpanContext over grpc using its request metadata. It will default to using the BinaryFormatter to serialize/deserialize SpanContext.

H

HttpHeaderPropagator — Class in namespace OpenCensus\Trace\Propagator: This propagator uses HTTP headers to propagate SpanContext over HTTP.

I

DaemonClient::init() — Method in class DaemonClient: Initialize our DaemonClient for Stats and/or Trace reporting to the OpenCensus PHP Daemon service.
IntMeasure — Class in namespace OpenCensus\Stats: IntMeasure is a Measure for Int values.
TagContext::insert() — Method in class TagContext: Insert a Tag into TagContext given provided TagKey and string value.
IdGeneratorTrait — Class in namespace OpenCensus\Trace: Trait which provides helper methods for generating trace identifiers.
IntegrationInterface — Class in namespace OpenCensus\Trace\Integrations: Common interface for enabling Trace integration for various frameworks and libraries.
MessageEvent::id() — Method in class MessageEvent: Return the id of this message event.
GrpcMetadataPropagator::inject() — Method in class GrpcMetadataPropagator: Persiste the current SpanContext back into the results of this request
HttpHeaderPropagator::inject() — Method in class HttpHeaderPropagator: Persists the current SpanContext back into the results of this request
PropagatorInterface::inject() — Method in class PropagatorInterface: Inject the SpanContext back into the response
RequestHandler::inSpan() — Method in class RequestHandler: Instrument a callable by creating a Span that manages the startTime and endTime. If an exception is thrown while executing the callable, the exception will be caught, the span will be closed, and the exception will be re-thrown.
Tracer::inSpan() — Method in class Tracer: Instrument a callable by creating a Span that manages the startTime and endTime.
ContextTracer::inSpan() — Method in class ContextTracer: Instrument a callable by creating a Span that manages the startTime and endTime.
ExtensionTracer::inSpan() — Method in class ExtensionTracer: Instrument a callable by creating a Span
NullTracer::inSpan() — Method in class NullTracer: Instrument a callable by creating a Span
TracerInterface::inSpan() — Method in class TracerInterface: Instrument a callable by creating a Span

K

GrpcMetadataPropagator::key() — Method in class GrpcMetadataPropagator: Return the key used to propagate the SpanContext
HttpHeaderPropagator::key() — Method in class HttpHeaderPropagator: Return the key used to propagate the SpanContext
PropagatorInterface::key() — Method in class PropagatorInterface: Return the key used to propagate the SpanContext
SpanData::kind() — Method in class SpanData: Returns the span kind.

L

Aggregation::lastValue() — Method in class Aggregation: Returns a new LastValue Aggregation.
NullEventHandler::linkAdded() — Method in class NullEventHandler: Triggers when a link is added to a span.
SpanEventHandlerInterface::linkAdded() — Method in class SpanEventHandlerInterface: Triggers when a link is added to a span.
LoggerExporter — Class in namespace OpenCensus\Trace\Exporter: This implementation of the ExporterInterface sends log messages to a configurable PSR-3 logger.
Curl::load() — Method in class Curl: Static method to add instrumentation to curl requests
Doctrine::load() — Method in class Doctrine: Static method to add instrumentation to Doctrine ORM calls
Eloquent::load() — Method in class Eloquent: Static method to add instrumentation to Eloquent ORM calls
Grpc::load() — Method in class Grpc: Static method to add instrumentation to grpc requests
IntegrationInterface::load() — Method in class IntegrationInterface: Static method to add instrumentation to a framework or library
Laravel — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting the Laravel framework's standard stack using the opencensus extension.
Laravel::load() — Method in class Laravel: Static method to add instrumentation to the Laravel framework
Memcached::load() — Method in class Memcached: Static method to add instrumentation to memcache requests
Mysql::load() — Method in class Mysql: Static method to add instrumentation to mysql requests
PDO::load() — Method in class PDO: Static method to add instrumentation to the PDO requests
Postgres::load() — Method in class Postgres: Static method to add instrumentation to the postgres requests
Symfony::load() — Method in class Symfony: Static method to add instrumentation to the Symfony framework
Wordpress::load() — Method in class Wordpress: Static method to add instrumentation to the Wordpress framework
Link — Class in namespace OpenCensus\Trace: A class that represents a Link resource.
SpanData::links() — Method in class SpanData: Return the links for this span.
ExtensionTracer::linkAdded() — Method in class ExtensionTracer: Triggers when a link is added to a span.

M

FloatMeasure::m() — Method in class FloatMeasure: Creates a Measurement of provided value.
IntMeasure::m() — Method in class IntMeasure: Creates a Measurement of provided value.
Measure — Class in namespace OpenCensus\Stats: Measure represents a single numeric value to be tracked and recorded.
$Measure#map — Property in class Measure: Contains our initialized Measure's
MeasureHandleTrait — Class in namespace OpenCensus\Stats: Trait which handles Measure creation. Takes care of name validation and deduplication.
Measurement — Class in namespace OpenCensus\Stats: Base clase for Measurements.
MeasurementInterface — Class in namespace OpenCensus\Stats: Interface for handling a Measurement Map.
MeasurementMap — Class in namespace OpenCensus\Stats: MeasurementMap for recording Measurements.
Middleware — Class in namespace OpenCensus\Trace\Integrations\Guzzle: This class handles integration with GuzzleHttp 6. Adding this middleware to your Guzzle client, will enable distrubted tracing by passing along the trace context header and will also create trace spans for all outgoing requests.
Memcached — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting memcache requests using the opencensus extension.
Mysql — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting mysql requests using the opencensus extension.
MessageEvent — Class in namespace OpenCensus\Trace: A class that represents a MessageEvent resource.
MultiSampler — Class in namespace OpenCensus\Trace\Sampler: This implementation of the SamplerInterface wraps any number of child SamplerInterface implementations. All provided implementations must return true in order for the request to be sampled.
Status::message() — Method in class Status: Returns the developer-facing error message

N

NoopExporter — Class in namespace OpenCensus\Stats\Exporter
$Measure#name — Property in class Measure: Holds our Measure's name.
Measure::newIntMeasure() — Method in class Measure: Constructs a new IntMeasure.
Measure::newFloatMeasure() — Method in class Measure: Constructs a new FloatMeasure.
NoopMeasurementMap — Class in namespace OpenCensus\Stats: NoopMeasurementMap is a Noop implementation for Measurement recording.
Stats::newTagContext() — Method in class Stats: Return a new TagContext object.
Stats::newMeasurementMap() — Method in class Stats: Retrieve a new MeasurementInterface for recording Measurements
TagContext::new() — Method in class TagContext: Copy and return the TagContext as found in the provided Context object.
TagContext::newContext() — Method in class TagContext: Creates a new Context with our TagContext attached.
NullEventHandler — Class in namespace OpenCensus\Trace\EventHandler: This implementation of the SpanEventHandlerInterface does nothing.
NullExporter — Class in namespace OpenCensus\Trace\Exporter: This implementation of the ExporterInterface does nothing.
NeverSampleSampler — Class in namespace OpenCensus\Trace\Sampler: This implementation of the SamplerInterface always returns false. Use this sampler to disable all tracing.
SpanData::name() — Method in class SpanData: Retrieve the name of this span.
NullTracer — Class in namespace OpenCensus\Trace\Tracer: This implementation of the TracerInterface is the null object implementation.

O

OneLineEchoExporter — Class in namespace OpenCensus\Trace\Exporter
EventSubscriber::onBefore() — Method in class EventSubscriber: Handler for the BeforeEvent request lifecycle event. Adds the current trace context as the trace context header. Also starts a span representing this outgoing http request.
EventSubscriber::onEnd() — Method in class EventSubscriber: Handler for the EndEvent request lifecycle event. Ends the current span which should be the span started in the BeforeEvent handler.
RequestHandler::onExit() — Method in class RequestHandler: The function registered as the shutdown function. Cleans up the trace and reports using the provided ExporterInterface. Adds additional attributes to the root span detected from the response.

P

MeasurementInterface::put() — Method in class MeasurementInterface: Add a Measurement to our map.
MeasurementInterface::putAttachment() — Method in class MeasurementInterface: Add an Exemplar Attachment to our map. If the key already exists, the existing Attachment in the map will be overriden with the new value.
MeasurementMap::put() — Method in class MeasurementMap: Add a Measurement to our map.
MeasurementMap::putAttachment() — Method in class MeasurementMap: Add an Exemplar Attachment to our map. If the key already exists, the existing Attachment in the map will be overriden with the new value.
NoopMeasurementMap::put() — Method in class NoopMeasurementMap: Add a Measurement to our map.
NoopMeasurementMap::putAttachment() — Method in class NoopMeasurementMap: Add an Exemplar Attachment to our map. If the key already exists, the existing Attachment in the map will be overriden with the new value.
PDO — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting PDO requests using the opencensus extension.
Postgres — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting postgres requests using the opencensus extension.
PropagatorInterface — Class in namespace OpenCensus\Trace\Propagator: This interface lets us define separate SpanContext Propagator formats. This interface is responsible for parsing and propagating the SpanContext to upstream and downstream requests.
ProbabilitySampler — Class in namespace OpenCensus\Trace\Sampler: This implementation of the SamplerInterface uses a pseudo-random number generator to sample a percentage of requests.
SpanData::parentSpanId() — Method in class SpanData: Retrieve the ID of this span's parent if it exists.
PrintableTrait — Class in namespace OpenCensus\Utils: Internal utility methods for working with tag keys, tag values, and metric names.

Q

QpsSampler — Class in namespace OpenCensus\Trace\Sampler: This implementation of the SamplerInterface uses a cache to limit sampling to the a certain number of queries per second. It requires a PSR-6 cache implementation.

R

DaemonClient::registerView() — Method in class DaemonClient: Register views.
DaemonClient::recordStats() — Method in class DaemonClient: Record the provided Measurements, Attachments and Tags.
ExporterInterface::registerView() — Method in class ExporterInterface: Register views.
ExporterInterface::recordStats() — Method in class ExporterInterface: Record the provided Measurements, Attachments and Tags.
NoopExporter::registerView() — Method in class NoopExporter: Register views.
NoopExporter::recordStats() — Method in class NoopExporter: Record the provided Measurements, Attachments and Tags.
MeasurementInterface::record() — Method in class MeasurementInterface: Record the Measurements, Attachments and Tags found in the map.
MeasurementMap::record() — Method in class MeasurementMap: Record the Measurements, Attachments and Tags found in the map.
NoopMeasurementMap::record() — Method in class NoopMeasurementMap: Record the Measurements, Attachments and Tags found in the map.
Stats::registerView() — Method in class Stats: Register one or multiple views.
RequestHandler — Class in namespace OpenCensus\Trace: This class manages the logic for sampling and reporting a trace within a single request. It is not meant to be used directly -- instead, it should be managed by the Tracer as its singleton instance.
ProbabilitySampler::rate() — Method in class ProbabilitySampler: Return the percentage of requests to sample represented as a float between 0 and 1
QpsSampler::rate() — Method in class QpsSampler: Return the query-per-second rate

S

DaemonClient::setReportingPeriod() — Method in class DaemonClient: Adjust the stats reporting period of the Daemom.
Scope — Class in namespace OpenCensus\Core: This class in an implementation of a generic scope that has something to execute when the scope finishes.
ExporterInterface::setReportingPeriod() — Method in class ExporterInterface: Adjust the stats reporting period of the Daemom.
NoopExporter::setReportingPeriod() — Method in class NoopExporter: Adjust the stats reporting period of the Daemom.
Stats — Class in namespace OpenCensus\Stats: This class provides static functions to give you access to the most common Stats actions.
Stats::setExporter() — Method in class Stats: Set the ExporterInterface to use by the Stats components.
Aggregation::sum() — Method in class Aggregation: Returns a new Sum Aggregation.
SpanEventHandlerInterface — Class in namespace OpenCensus\Trace\EventHandler: This interface defines events that are triggered when a Span is updated.
Symfony — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting the Symfony framework's standard stack using the opencensus extension.
Link::spanId() — Method in class Link: Return the spanId for this link.
BinaryFormatter::serialize() — Method in class BinaryFormatter: Convert a SpanContext to header string
CloudTraceFormatter::serialize() — Method in class CloudTraceFormatter: Convert a SpanContext to header string
FormatterInterface::serialize() — Method in class FormatterInterface: Convert a SpanContext to header string
TraceContextFormatter::serialize() — Method in class TraceContextFormatter: Convert a SpanContext to header string. Uses version 0.
RequestHandler::startSpan() — Method in class RequestHandler: Explicitly start a new Span. You will need to manage finishing the Span, including handling any thrown exceptions.
AlwaysSampleSampler::shouldSample() — Method in class AlwaysSampleSampler: Returns true because we always want to sample.
MultiSampler::shouldSample() — Method in class MultiSampler: Returns false if any provided sampler chooses not to sample this request.
NeverSampleSampler::shouldSample() — Method in class NeverSampleSampler: Returns false because we never want to sample.
ProbabilitySampler::shouldSample() — Method in class ProbabilitySampler: Uses a pseudo-random number generator to decide if we should sample the request.
QpsSampler::shouldSample() — Method in class QpsSampler: Returns whether or not the request should be sampled.
SamplerInterface — Class in namespace OpenCensus\Trace\Sampler: This interface lets us customize the sampling logic.
SamplerInterface::shouldSample() — Method in class SamplerInterface: Returns true if we whould sample the request
Span — Class in namespace OpenCensus\Trace: This plain PHP class represents a single timed event within a Trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
Span::setStartTime() — Method in class Span: Set the start time for this span.
Span::setEndTime() — Method in class Span: Set the end time for this span.
Span::spanId() — Method in class Span: Retrieve the ID of this span.
Span::spanData() — Method in class Span: Return a read-only version of this span.
Span::setStatus() — Method in class Span: Set the status for this span.
SpanContext — Class in namespace OpenCensus\Trace: SpanContext encapsulates your current context within your request's trace. It includes 3 fields: the traceId, the current spanId, and an enabled flag which indicates whether or not the request is being traced.
SpanContext::spanId() — Method in class SpanContext: Fetch the current spanId.
SpanContext::setSpanId() — Method in class SpanContext: Set the current spanId.
SpanContext::setEnabled() — Method in class SpanContext: Set whether or not the request is being traced.
SpanData — Class in namespace OpenCensus\Trace: This plain PHP class represents a read-only version of a single timed event within a Trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
SpanData::startTime() — Method in class SpanData: Retrieve the start time for this span.
SpanData::spanId() — Method in class SpanData: Retrieve the ID of this span.
SpanData::status() — Method in class SpanData: Retrieve the final status for this span.
SpanData::stackTrace() — Method in class SpanData: Retrieve the stackTrace at the moment this span was created
SpanData::stackTraceHashId() — Method in class SpanData: Return a hash id for this span's stackTrace in hexadecimal
SpanData::sameProcessAsParentSpan() — Method in class SpanData: Whether or not this span is in the same process as its parent.
Status — Class in namespace OpenCensus\Trace: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC.
TimeEvent::setTime() — Method in class TimeEvent: Set the time for this event.
Tracer::start() — Method in class Tracer: Start a new trace session for this request. You should call this as early as possible for the most accurate results.
Tracer::startSpan() — Method in class Tracer: Explicitly start a new Span. You will need to attach the span and handle any thrown exceptions.
Tracer::spanContext() — Method in class Tracer: Returns the current span context.
ContextTracer::startSpan() — Method in class ContextTracer: Create a new Span. The start time is already set to the current time.
ContextTracer::spans() — Method in class ContextTracer: Return the spans collected.
ContextTracer::spanContext() — Method in class ContextTracer: Returns the current SpanContext
ExtensionTracer::startSpan() — Method in class ExtensionTracer: Start a new Span. The start time is already set to the current time.
ExtensionTracer::spans() — Method in class ExtensionTracer: Return the spans collected.
ExtensionTracer::spanContext() — Method in class ExtensionTracer: Returns the current SpanContext
NullTracer::startSpan() — Method in class NullTracer: Start a new Span. The start time is already set to the current time.
NullTracer::spans() — Method in class NullTracer: Return the spans collected.
NullTracer::spanContext() — Method in class NullTracer: Returns the current SpanContext
TracerInterface::startSpan() — Method in class TracerInterface: Start a new Span. The start time is already set to the current time.
TracerInterface::spans() — Method in class TracerInterface: Return the spans collected.
TracerInterface::spanContext() — Method in class TracerInterface: Returns the current SpanContext

T

Tag — Class in namespace OpenCensus\Tags: A tag is a key-value pair.
TagContext — Class in namespace OpenCensus\Tags: TagContext represents a collection of tags.
TagContext::tags() — Method in class TagContext: Returns an array of Tag objects this map holds.
TagKey — Class in namespace OpenCensus\Tags: A key to a value stored in a TagContext
TagValue — Class in namespace OpenCensus\Tags: A key to a value stored in a TagContext
NullEventHandler::timeEventAdded() — Method in class NullEventHandler: Triggers when a time event is added to a span.
SpanEventHandlerInterface::timeEventAdded() — Method in class SpanEventHandlerInterface: Triggers when a time event is added to a span.
Link::traceId() — Method in class Link: Return the traceId for this link.
Link::type() — Method in class Link: Return the type for this link.
MessageEvent::type() — Method in class MessageEvent: Return the type of this message event.
TraceContextFormatter — Class in namespace OpenCensus\Trace\Propagator: This format using a human readable string encoding to propagate SpanContext.
RequestHandler::tracer() — Method in class RequestHandler: Return the tracer used for this request.
SpanContext::traceId() — Method in class SpanContext: Fetch the current traceId.
SpanData::traceId() — Method in class SpanData: Retrieve the ID of this span's trace.
SpanData::timeEvents() — Method in class SpanData: Return the time events for this span.
TimeEvent — Class in namespace OpenCensus\Trace: An abstract class that represents a TimeEvent resource.
$TimeEvent#time — Property in class TimeEvent
TimeEvent::time() — Method in class TimeEvent: Return the time of this event.
Tracer — Class in namespace OpenCensus\Trace: This class provides static functions to give you access to the current request's singleton tracer. You should use this class to instrument your code.
ExtensionTracer::timeEventAdded() — Method in class ExtensionTracer: Triggers when a time event is added to a span.
TracerInterface — Class in namespace OpenCensus\Trace\Tracer: This interface allows you to use the null object pattern for your tracer.

U

DaemonClient::unregisterView() — Method in class DaemonClient: Unregister views.
ExporterInterface::unregisterView() — Method in class ExporterInterface: Unregister views.
NoopExporter::unregisterView() — Method in class NoopExporter: Unregister views.
$Measure#unit — Property in class Measure: Holds the unit type of the value this measure takes on.
Stats::unregisterView() — Method in class Stats: Unregister one or multiple views.
TagContext::update() — Method in class TagContext: Update a Tag into TagContext given provided TagKey with string value.
TagContext::upsert() — Method in class TagContext: Insert or Update a Tag into TagContext given provided TagKey with provided string value.
Grpc::updateMetadata() — Method in class Grpc: Update metadata handler for grpc clients.
MessageEvent::uncompressedSize() — Method in class MessageEvent: Return the uncompressed size of this message event.

V

Context::value() — Method in class Context: Fetches the value for a given key in this context. Returns the provided default if not set.
Context::values() — Method in class Context: Returns all the contained data.
View — Class in namespace OpenCensus\Stats\View: View allows users to aggregate the recorded stats.Measurements.
TagContext::value() — Method in class TagContext: Returns the value for the key if a value for the key exists.
VarintTrait — Class in namespace OpenCensus\Utils: Varint encoding and decoding methods inspired by Go encoding/binary package.
Version — Class in namespace OpenCensus: This class provides a constant for the current version of this library.

W

Context::withValue() — Method in class Context: Creates a new context with the given key/value set.
Context::withValues() — Method in class Context: Creates a new context with the given key/values.
Wordpress — Class in namespace OpenCensus\Trace\Integrations: This class handles instrumenting the Wordpress framework's standard stack using the opencensus extension.
RequestHandler::withSpan() — Method in class RequestHandler: Attaches the provided span as the current span and returns a Scope object which must be closed.
Tracer::withSpan() — Method in class Tracer: Attaches the provided span as the current span and returns a Scope object which must be closed.
ContextTracer::withSpan() — Method in class ContextTracer: Attaches the provided span as the current span and returns a Scope object which must be closed.
ExtensionTracer::withSpan() — Method in class ExtensionTracer: Attaches the provided span as the current span and returns a Scope object which must be closed.
NullTracer::withSpan() — Method in class NullTracer: Attaches the provided span as the current span and returns a Scope object which must be closed.
TracerInterface::withSpan() — Method in class TracerInterface: Attaches the provided span as the current span and returns a Scope object which must be closed.

_

Context::__construct() — Method in class Context: Creates a new Context.
Scope::__construct() — Method in class Scope: Creates a new Scope
View::__construct() — Method in class View: Creates a new View.
Tag::__construct() — Method in class Tag: Creates a Tag out of a TagKey and TagValue.
TagContext::__toString() — Method in class TagContext: Serializes the TagContext to a string representation.
Annotation::__construct() — Method in class Annotation: Create a new Annotation.
FileExporter::__construct() — Method in class FileExporter: Create a new EchoExporter
LoggerExporter::__construct() — Method in class LoggerExporter: Create a new LoggerExporter
EventSubscriber::__construct() — Method in class EventSubscriber: Create a new Guzzle event listener that creates trace spans and propagates the current trace context to the downstream request.
Middleware::__construct() — Method in class Middleware: Create a new Guzzle middleware that creates trace spans and propagates the current trace context to the downstream request.
Middleware::__invoke() — Method in class Middleware: Magic method which makes this object callable. Guzzle middleware are expected to be callables.
Link::__construct() — Method in class Link: Create a new Link.
MessageEvent::__construct() — Method in class MessageEvent: Create a new MessageEvent.
GrpcMetadataPropagator::__construct() — Method in class GrpcMetadataPropagator: Create a new GrpcMetadataPropagator
HttpHeaderPropagator::__construct() — Method in class HttpHeaderPropagator: Create a new HttpHeaderPropagator
RequestHandler::__construct() — Method in class RequestHandler: Create a new RequestHandler.
MultiSampler::__construct() — Method in class MultiSampler: Create a new MultiSampler.
ProbabilitySampler::__construct() — Method in class ProbabilitySampler: Creates the ProbabilitySampler
QpsSampler::__construct() — Method in class QpsSampler: Create a new QpsSampler. If the provided cache is shared between servers, the queries per second will be counted across servers. If the cache is shared between servers and you wish to sample independently on the servers, provide your own cache key that is different on each server.
Span::__construct() — Method in class Span: Instantiate a new Span instance.
SpanContext::__construct() — Method in class SpanContext: Creates a new SpanContext instance
SpanData::__construct() — Method in class SpanData: Instantiate a new SpanData instance.
Status::__construct() — Method in class Status: Create a new Status object
TimeEvent::__construct() — Method in class TimeEvent: Create a new TimeEvent.
ContextTracer::__construct() — Method in class ContextTracer: Create a new ContextTracer
ExtensionTracer::__construct() — Method in class ExtensionTracer: Create a new ExtensionTracer