You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 3, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+37-3Lines changed: 37 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# OpenCensus Libraries for Node.js
2
-
[![Gitter chat][gitter-image]][gitter-url]
2
+
[![Gitter chat][gitter-image]][gitter-url]![Node Version][node-img][![NPM Published Version][npm-img]][npm-url]![Apache License][license-image]
3
3
4
4
OpenCensus Node.js is an implementation of OpenCensus, a toolkit for collecting application performance and behavior monitoring data. Right now OpenCensus for Node.js supports custom tracing and automatic tracing for HTTP and HTTPS. Please visit the [OpenCensus Node.js package](https://github.com/census-instrumentation/opencensus-node/tree/master/packages/opencensus-nodejs) for usage.
5
5
@@ -21,6 +21,8 @@ OpenCensus can collect tracing data automatically using plugins. Users can also
@@ -34,18 +36,50 @@ OpenCensus collects distributed tracing. It is able to do so by propagating span
34
36
35
37
OpenCensus is vendor-agnostic and can upload data to any backend with various exporter implementations. Even though, OpenCensus provides support for many backends, users can also implement their own exporters for proprietary and unofficially supported backends. Currently, OpenCensus supports:
- If the application owner wants to export in-process tracing and stats data via HTML debugging pages see this [Z-Pages](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-zpages/README.md).
51
+
43
52
If no exporter is registered in the tracing instance, as default, a console log exporter is used.
44
53
54
+
## Versioning
55
+
56
+
This library follows [Semantic Versioning](http://semver.org/).
57
+
58
+
**GA**: Libraries defined at a GA quality level are stable, and will not introduce
59
+
backwards-incompatible changes in any minor or patch releases. We will address issues and requests
60
+
with the highest priority. If we were to make a backwards-incompatible changes on an API, we will
61
+
first mark the existing API as deprecated and keep it for 18 months before removing it.
62
+
63
+
**Beta**: Libraries defined at a Beta quality level are expected to be mostly stable and we're
64
+
working towards their release candidate. We will address issues and requests with a higher priority.
65
+
There may be backwards incompatible changes in a minor version release, though not in a patch
66
+
release. If an element is part of an API that is only meant to be used by exporters or other
67
+
opencensus libraries, then there is no deprecation period. Otherwise, we will deprecate it for 18
68
+
months before removing it, if possible.
69
+
70
+
**Alpha**: Libraries defined at a Alpha quality level can be unstable and could cause crashes or data loss. Alpha software may not contain all of the features that are planned for the final version. The API is subject to change.
71
+
45
72
## Useful links
46
73
- For more information on OpenCensus, visit: <https://opencensus.io/>
47
74
- For help or feedback on this project, join us on [gitter](https://gitter.im/census-instrumentation/Lobby)
0 commit comments