Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit c165623

Browse files
authored
Readme: update exporters, versioning, plugins, badges data (#278)
* Readme: update exporters, versioning, plugins, badges data * add alpha level
1 parent 90f1905 commit c165623

1 file changed

Lines changed: 37 additions & 3 deletions

File tree

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 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]
33

44
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.
55

@@ -21,6 +21,8 @@ OpenCensus can collect tracing data automatically using plugins. Users can also
2121

2222
- [HTTP](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-instrumentation-http/README.md)
2323
- [HTTPS](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-instrumentation-https/README.md)
24+
- [HTTP2](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-instrumentation-http2/README.md)
25+
- [GRPC](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-instrumentation-grpc/README.md)
2426

2527
## Propagation
2628

@@ -34,18 +36,50 @@ OpenCensus collects distributed tracing. It is able to do so by propagating span
3436

3537
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:
3638

39+
#### Trace exporters
3740
- [Stackdriver](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-stackdriver/README.md)
38-
- [Zipkin](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-zipkin/README.md)
39-
- [Z-Pages](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-zpages/README.md)
4041
- [Jaeger](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-jaeger/README.md)
42+
- [Zipkin](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-zipkin/README.md)
4143
- [Instana](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-instana/README.md)
4244

45+
#### Stats/Metrics exporters
46+
- [Stackdriver](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-stackdriver/README.md)
47+
- [Prometheus](https://github.com/census-instrumentation/opencensus-node/blob/master/packages/opencensus-exporter-prometheus/README.md)
48+
49+
#### How to setup debugging Z-Pages?
50+
- 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+
4352
If no exporter is registered in the tracing instance, as default, a console log exporter is used.
4453

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+
4572
## Useful links
4673
- For more information on OpenCensus, visit: <https://opencensus.io/>
4774
- For help or feedback on this project, join us on [gitter](https://gitter.im/census-instrumentation/Lobby)
4875

4976
[gitter-image]: https://badges.gitter.im/census-instrumentation/lobby.svg
5077
[gitter-url]: https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
78+
[npm-url]: https://www.npmjs.com/package/@opencensus/exporter-prometheus
79+
[npm-img]: https://badge.fury.io/js/%40opencensus%2Fexporter-prometheus.svg
80+
[node-img]: https://img.shields.io/node/v/@opencensus/exporter-prometheus.svg
81+
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
82+
83+
## LICENSE
5184

85+
Apache License 2.0

0 commit comments

Comments
 (0)