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

Commit 04a556a

Browse files
authored
docs: add link to official docs and alternatives
Be more explicit that the origins of this project were to add a stackdriver sink to applications already instrumented with go-metrics, and not as any sort of general recommendation to use go-metrics over the options outlined in official documentation.
1 parent 2fe63ce commit 04a556a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
This library provides a stackdriver sink for applications instrumented with the
55
[go-metrics](https://github.com/armon/go-metrics) library.
66

7+
## 🚨 Warning
8+
9+
__This is not an officially supported Google product.__
10+
11+
In general the author of this package would recommend instrumenting custom metrics for new code by following the [official GCP documentation](https://cloud.google.com/monitoring/custom-metrics), especially for new applications.
12+
13+
This package is intended as a way to publish metrics for applications that are _already_ instrumented with `go-metrics` without having to use a sidecar process like [stackdriver-prometheus-sidecar](https://github.com/Stackdriver/stackdriver-prometheus-sidecar).
14+
715
## Details
816

917
[stackdriver.NewSink](https://godoc.org/github.com/google/go-metrics-stackdriver#NewSink)'s return value satisfies the go-metrics library's [MetricSink](https://godoc.org/github.com/armon/go-metrics#MetricSink) interface. When providing a `stackdriver.Sink` to libraries and applications instrumented against `MetricSink`, the metrics will be aggregated within this library and written to stackdriver as [Generic Task](https://cloud.google.com/monitoring/api/resources#tag_generic_task) timeseries metrics.
@@ -28,6 +36,3 @@ The [full example](example/main.go) can be run from a cloud shell console to tes
2836
You can also try out the example using Cloud Run!
2937

3038
[![Run on Google Cloud](https://storage.googleapis.com/cloudrun/button.svg)](https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/google/go-metrics-stackdriver.git&cloudshell_working_dir=example)
31-
32-
33-
__This is not an officially supported Google product.__

0 commit comments

Comments
 (0)