From 1f1775886d7314b113acd322633afb278f875687 Mon Sep 17 00:00:00 2001 From: Aaron Abbott Date: Wed, 2 Oct 2024 21:35:05 -0400 Subject: [PATCH] Add links to quickstart and observability overview PyPI README.rst and sphinx docs (#359) --- docs/index.rst | 7 +++++++ opentelemetry-exporter-gcp-monitoring/README.rst | 7 +++++++ opentelemetry-exporter-gcp-trace/README.rst | 7 +++++++ opentelemetry-propagator-gcp/README.rst | 7 +++++++ opentelemetry-resourcedetector-gcp/README.rst | 7 +++++++ 5 files changed, 35 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 20a053ad..765c6501 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,13 @@ resource detectors for Google Cloud Platform. Development for these packages takes place on `Github `_. +To get started with instrumentation in Google Cloud, see `Generate traces and metrics with +Python `_. + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit `Instrumentation and observability +`_. + Installation ------------ diff --git a/opentelemetry-exporter-gcp-monitoring/README.rst b/opentelemetry-exporter-gcp-monitoring/README.rst index 95d7250c..822ef153 100644 --- a/opentelemetry-exporter-gcp-monitoring/README.rst +++ b/opentelemetry-exporter-gcp-monitoring/README.rst @@ -11,6 +11,13 @@ OpenTelemetry Google Cloud Monitoring Exporter This library provides support for exporting metrics to Google Cloud Monitoring. +To get started with instrumentation in Google Cloud, see `Generate traces and metrics with +Python `_. + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit `Instrumentation and observability +`_. + For resource detection and GCP trace context propagation, see `opentelemetry-tools-google-cloud `_. For the diff --git a/opentelemetry-exporter-gcp-trace/README.rst b/opentelemetry-exporter-gcp-trace/README.rst index 2942831d..27523235 100644 --- a/opentelemetry-exporter-gcp-trace/README.rst +++ b/opentelemetry-exporter-gcp-trace/README.rst @@ -10,6 +10,13 @@ OpenTelemetry Google Cloud Integration This library provides support for exporting traces to Google Cloud Trace. +To get started with instrumentation in Google Cloud, see `Generate traces and metrics with +Python `_. + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit `Instrumentation and observability +`_. + For resource detection and GCP trace context propagation, see `opentelemetry-tools-google-cloud `_. For the diff --git a/opentelemetry-propagator-gcp/README.rst b/opentelemetry-propagator-gcp/README.rst index 57a90fc4..fed74e65 100644 --- a/opentelemetry-propagator-gcp/README.rst +++ b/opentelemetry-propagator-gcp/README.rst @@ -11,6 +11,13 @@ OpenTelemetry Google Cloud Propagator This library provides support for propagating trace context in the Google Cloud ``X-Cloud-Trace-Context`` format. +To get started with instrumentation in Google Cloud, see `Generate traces and metrics with +Python `_. + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit `Instrumentation and observability +`_. + Installation ------------ diff --git a/opentelemetry-resourcedetector-gcp/README.rst b/opentelemetry-resourcedetector-gcp/README.rst index d3a7c6f9..a4a1ed8e 100644 --- a/opentelemetry-resourcedetector-gcp/README.rst +++ b/opentelemetry-resourcedetector-gcp/README.rst @@ -10,6 +10,13 @@ OpenTelemetry Google Cloud Resource Detector This library provides support for detecting GCP resources like GCE, GKE, etc. +To get started with instrumentation in Google Cloud, see `Generate traces and metrics with +Python `_. + +To learn more about instrumentation and observability, including opinionated recommendations +for Google Cloud Observability, visit `Instrumentation and observability +`_. + Installation ------------