77
88## Installation
99
10+ ### PHP library
11+
10121 . Install with ` composer ` or add to your ` composer.json ` .
1113
1214```
@@ -22,11 +24,25 @@ use OpenCensus\Trace\Reporter\EchoReporter;
2224RequestTracer::start(new EchoReporter());
2325```
2426
27+ ### PHP Extension
28+
29+ 1 . Install the ` opencensus ` extension from PECL.
30+
31+ ```
32+ $ pecl install opencensus
33+ ```
34+
35+ 2 . Enable the extension in your ` php.ini ` .
36+
37+ ```
38+ extension=opencensus.so
39+ ```
40+
2541## Customizing
2642
2743### Reporting Traces
2844
29- The above sample uses the ` EchoReporter ` to report dump trace results to the
45+ The above sample uses the ` EchoReporter ` to dump trace results to the
3046bottom of the webpage.
3147
3248If you would like to provide your own reporter, create a class that implements ` ReporterInterface ` .
@@ -98,3 +114,49 @@ try {
98114```
99115
100116### OpenCensus extension
117+
118+ The ` opencensus ` extension collects nested span data throughout the course of your application's
119+ execution. You can collect spans in 2 ways, by watching for function/method invocations or by manually
120+ starting and stopping spans. In both cases, the spans will be collected together and can be retrieved
121+ at the end of the request.
122+
123+ See [ extension README] ( ext/README.md ) for more information.
124+
125+ ## Versioning
126+
127+ You can retrieve the version of this extension at runtime.
128+
129+ ``` php
130+ /**
131+ * Return the current version of the opencensus_trace extension
132+ *
133+ * @return string
134+ */
135+ function opencensus_trace_version();
136+ ```
137+
138+ This library follows [ Semantic Versioning] ( http://semver.org/ ) .
139+
140+ Please note it is currently under active development. Any release versioned
141+ 0.x.y is subject to backwards incompatible changes at any time.
142+
143+ ** GA** : Libraries defined at a GA quality level are stable, and will not
144+ introduce backwards-incompatible changes in any minor or patch releases. We will
145+ address issues and requests with the highest priority.
146+
147+ ** Beta** : Libraries defined at a Beta quality level are expected to be mostly
148+ stable and we're working towards their release candidate. We will address issues
149+ and requests with a higher priority.
150+
151+ ** Alpha** : Libraries defined at an Alpha quality level are still a
152+ work-in-progress and are more likely to get backwards-incompatible updates.
153+
154+ ## Contributing
155+
156+ Contributions to this library are always welcome and highly encouraged.
157+
158+ See [ CONTRIBUTING] ( CONTRIBUTING.md ) for more information on how to get started.
159+
160+ ## License
161+
162+ Apache 2.0 - See [ LICENSE] ( LICENSE ) for more information.
0 commit comments