Skip to content

Commit

Permalink
docs: Add maintenance mode notice to README (#1492)
Browse files Browse the repository at this point in the history
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
punya and gcf-owl-bot[bot] committed Mar 24, 2023
1 parent 86186bb commit 81d9d5c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .readme-partials.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
body: |-
> **Warning**
>
> `cloud-trace-nodejs` is in maintenance mode. This means that we'll continue to fix bugs
> add add security patches. We'll consider merging new feature contributions (depending
> on the anticipated maintenance cost). But we won't develop new features ourselves.
>
> In particular, we will not add support for new major versions of libraries.
>
> We encourage users to migrate to [OpenTelemetry JS Instrumentation][otel] instead.
This module provides automatic tracing for Node.js applications with Cloud Trace. [Cloud Trace](https://cloud.google.com/cloud-trace/) is a feature of [Google Cloud Platform](https://cloud.google.com/) that collects latency data (traces) from your applications and displays it in near real-time in the [Google Cloud Console][cloud-console].
<img src="https://raw.githubusercontent.com/googleapis/cloud-trace-nodejs/master/doc/images/cloud-trace-overview-page.png" alt="Cloud Trace Overview" />
Expand Down Expand Up @@ -160,3 +170,4 @@ body: |-
[codecov-url]: https://codecov.io/gh/googleapis/cloud-trace-nodejs
[queuing-problem]: https://github.com/groundwater/nodejs-symposiums/tree/master/2016-02-26-Errors/Round1/UserModeQueuing
[setting-up-stackdriver-trace]: https://cloud.google.com/trace/docs/setup/nodejs
[otel]: https://opentelemetry.io/docs/instrumentation/js/libraries/
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,16 @@ npm install @google-cloud/trace-agent
```


> **Warning**
>
> `cloud-trace-nodejs` is in maintenance mode. This means that we'll continue to fix bugs
> add add security patches. We'll consider merging new feature contributions (depending
> on the anticipated maintenance cost). But we won't develop new features ourselves.
>
> In particular, we will not add support for new major versions of libraries.
>
> We encourage users to migrate to [OpenTelemetry JS Instrumentation][otel] instead.
This module provides automatic tracing for Node.js applications with Cloud Trace. [Cloud Trace](https://cloud.google.com/cloud-trace/) is a feature of [Google Cloud Platform](https://cloud.google.com/) that collects latency data (traces) from your applications and displays it in near real-time in the [Google Cloud Console][cloud-console].

<img src="https://raw.githubusercontent.com/googleapis/cloud-trace-nodejs/master/doc/images/cloud-trace-overview-page.png" alt="Cloud Trace Overview" />
Expand Down Expand Up @@ -213,6 +223,7 @@ The Trace Agent does not support bundled server code, so bundlers like webpack o
[codecov-url]: https://codecov.io/gh/googleapis/cloud-trace-nodejs
[queuing-problem]: https://github.com/groundwater/nodejs-symposiums/tree/master/2016-02-26-Errors/Round1/UserModeQueuing
[setting-up-stackdriver-trace]: https://cloud.google.com/trace/docs/setup/nodejs
[otel]: https://opentelemetry.io/docs/instrumentation/js/libraries/


## Samples
Expand Down

0 comments on commit 81d9d5c

Please sign in to comment.