Skip to content

Commit 16bba4f

Browse files
authored
Add links to quickstart and observability overview to READMEs (#899)
Added to the root README and those for the SDK exporters and propagators which appear on https://pkg.go.dev.
1 parent 40a2c3c commit 16bba4f

File tree

4 files changed

+30
-2
lines changed

4 files changed

+30
-2
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
This repository contains the source code of 2 packages of OpenTelemetry exporters to [Google Cloud Trace](https://cloud.google.com/trace) and [Google Cloud Monitoring](https://cloud.google.com/monitoring).
66

7+
To get started with instrumentation in Google Cloud, see [Generate traces and metrics with
8+
Go](https://cloud.google.com/stackdriver/docs/instrumentation/setup/go).
9+
10+
To learn more about instrumentation and observability, including opinionated recommendations
11+
for Google Cloud Observability, visit [Instrumentation and
12+
observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview).
13+
714
## OpenTelemetry Google Cloud Trace Exporter
815

916
OpenTelemetry Google Cloud Trace Exporter allow the user to send collected traces and spans to Google Cloud.

exporter/metric/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@
33
[![Docs](https://godoc.org/github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric?status.svg)](https://pkg.go.dev/github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric)
44
[![Apache License][license-image]][license-url]
55

6-
OpenTelemetry Google Cloud Monitoring Exporter allow the user to send collected metrics to Google Cloud.
6+
OpenTelemetry Google Cloud Monitoring Exporter allows the user to send collected metrics to Google Cloud.
7+
8+
To get started with instrumentation in Google Cloud, see [Generate traces and metrics with
9+
Go](https://cloud.google.com/stackdriver/docs/instrumentation/setup/go).
10+
11+
To learn more about instrumentation and observability, including opinionated recommendations
12+
for Google Cloud Observability, visit [Instrumentation and
13+
observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview).
714

815
[Google 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.
916

exporter/trace/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55

66
OpenTelemetry Google Cloud Trace Exporter allows the user to send collected traces and spans to Google Cloud.
77

8+
To get started with instrumentation in Google Cloud, see [Generate traces and metrics with
9+
Go](https://cloud.google.com/stackdriver/docs/instrumentation/setup/go).
10+
11+
To learn more about instrumentation and observability, including opinionated recommendations
12+
for Google Cloud Observability, visit [Instrumentation and
13+
observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview).
14+
815
[Google Cloud Trace](https://cloud.google.com/trace) is a distributed tracing backend system. It helps developers to gather timing data needed to troubleshoot latency problems in microservice & monolithic architectures. It manages both the collection and lookup of gathered trace data.
916

1017
This exporter package assumes your application is [already instrumented](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/instrumentation/net/http/otelhttp/example/client/client.go) with the OpenTelemetry SDK. Once you get ready to export OpenTelemetry data, you can add this exporter to your application.

propagator/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ This package contains Trace Context Propagators for use with [Google Cloud
66
Trace](https://cloud.google.com/trace) that make it compatible with
77
[OpenTelemetry](http://opentelemetry.io).
88

9+
To get started with instrumentation in Google Cloud, see [Generate traces and metrics with
10+
Go](https://cloud.google.com/stackdriver/docs/instrumentation/setup/go).
11+
12+
To learn more about instrumentation and observability, including opinionated recommendations
13+
for Google Cloud Observability, visit [Instrumentation and
14+
observability](https://cloud.google.com/stackdriver/docs/instrumentation/overview).
15+
916
There are two available propagators in this package:
1017

1118
### `CloudTraceOneWayPropagator` (Recommended)
@@ -95,4 +102,4 @@ sampler := sdktrace.ParentBased(
95102
sdktrace.NeverSample(),
96103
sdktrace.WithRemoteParentSampled(sdktrace.AlwaysSample()))
97104
)
98-
```
105+
```

0 commit comments

Comments
 (0)