diff --git a/README.md b/README.md index aa2bd359..38696134 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ The packages in this repository support all [officially supported Node.js versions](https://nodejs.org/en/about/releases/) (10, 12, 14, 16). +To get started with instrumentation in Google Cloud, see [Generate traces and metrics with +Node.js](https://cloud.google.com/stackdriver/docs/instrumentation/setup/nodejs). + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit [Instrumentation and +observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview). + ## OpenTelemetry Google Cloud Trace Exporter [![npm version](https://badge.fury.io/js/%40google-cloud%2Fopentelemetry-cloud-trace-exporter.svg)](https://badge.fury.io/js/%40google-cloud%2Fopentelemetry-cloud-trace-exporter) diff --git a/packages/opentelemetry-cloud-monitoring-exporter/README.md b/packages/opentelemetry-cloud-monitoring-exporter/README.md index 02c17090..aedb1892 100644 --- a/packages/opentelemetry-cloud-monitoring-exporter/README.md +++ b/packages/opentelemetry-cloud-monitoring-exporter/README.md @@ -2,9 +2,15 @@ [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image] -OpenTelemetry Google Cloud Monitoring Exporter allows the user to send collected metrics to Google Cloud Monitoring. +OpenTelemetry Google Cloud Monitoring Exporter allows the user to send collected metrics to +[Google Cloud Monitoring](https://cloud.google.com/monitoring). -[Cloud Monitoring](https://cloud.google.com/monitoring) provides visibility into the performance, uptime, and overall health of cloud-powered applications. It collects metrics, events, and metadata from Google Cloud, Amazon Web Services, hosted uptime probes, application instrumentation, and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch, and many others. Operations ingests that data and generates insights via dashboards, charts, and alerts. Cloud Monitoring alerting helps you collaborate by integrating with Slack, PagerDuty, and more. +To get started with instrumentation in Google Cloud, see [Generate traces and metrics with +Node.js](https://cloud.google.com/stackdriver/docs/instrumentation/setup/nodejs). + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit [Instrumentation and +observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview). ## Installation diff --git a/packages/opentelemetry-cloud-trace-exporter/README.md b/packages/opentelemetry-cloud-trace-exporter/README.md index 561e135e..07217909 100644 --- a/packages/opentelemetry-cloud-trace-exporter/README.md +++ b/packages/opentelemetry-cloud-trace-exporter/README.md @@ -2,9 +2,15 @@ [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image] -OpenTelemetry Google Cloud Trace Exporter allows the user to send collected traces to Google Cloud. +OpenTelemetry Google Cloud Trace Exporter allows the user to send collected traces to [Google +Cloud Trace](https://cloud.google.com/trace). -[Google Cloud Trace](https://cloud.google.com/trace) is a distributed tracing system. It helps gather timing data needed to troubleshoot latency problems in microservice architectures. It manages both the collection and lookup of this data. +To get started with instrumentation in Google Cloud, see [Generate traces and metrics with +Node.js](https://cloud.google.com/stackdriver/docs/instrumentation/setup/nodejs). + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit [Instrumentation and +observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview). ## Setup diff --git a/packages/opentelemetry-cloud-trace-propagator/README.md b/packages/opentelemetry-cloud-trace-propagator/README.md index 6f747c0c..5b7cab35 100644 --- a/packages/opentelemetry-cloud-trace-propagator/README.md +++ b/packages/opentelemetry-cloud-trace-propagator/README.md @@ -4,6 +4,13 @@ OpenTelemetry Google Cloud Trace Propagator allows other services to create spans with the right context. +To get started with instrumentation in Google Cloud, see [Generate traces and metrics with +Node.js](https://cloud.google.com/stackdriver/docs/instrumentation/setup/nodejs). + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit [Instrumentation and +observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview). + Format: `TRACE_ID/SPAN_ID;o=TRACE_TRUE` diff --git a/packages/opentelemetry-resource-util/README.md b/packages/opentelemetry-resource-util/README.md index fab9e00e..0a1ae8ba 100644 --- a/packages/opentelemetry-resource-util/README.md +++ b/packages/opentelemetry-resource-util/README.md @@ -7,6 +7,13 @@ This package provides utils used by other packages in this repo. It can map OpenTelemetry resources to Google Cloud monitored resources. It is not intended to be used directly by users. +To get started with instrumentation in Google Cloud, see [Generate traces and metrics with +Node.js](https://cloud.google.com/stackdriver/docs/instrumentation/setup/nodejs). + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit [Instrumentation and +observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview). + ## Useful links - For more information on OpenTelemetry, visit: diff --git a/samples/instrumentation-quickstart/README.md b/samples/instrumentation-quickstart/README.md index 527c50f1..6ca115b0 100644 --- a/samples/instrumentation-quickstart/README.md +++ b/samples/instrumentation-quickstart/README.md @@ -4,6 +4,9 @@ > This sample is not an npm workspace within this repo. It does not link in any dependencies > from this repo and all commands should be run directly from this directory. +This is the code sample for [Generate traces and metrics with +Node.js](https://cloud.google.com/stackdriver/docs/instrumentation/setup/nodejs). + This sample is a [Fastify](https://fastify.dev/) Node.js application instrumented with [OpenTelemetry JS auto instrumentation](https://opentelemetry.io/docs/languages/js/automatic/). This is a Node.js version of [this golang