Skip to content

x/telemetry,x/website: add go.dev/doc/telemetry #63883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
findleyr opened this issue Nov 1, 2023 · 5 comments
Closed

x/telemetry,x/website: add go.dev/doc/telemetry #63883

findleyr opened this issue Nov 1, 2023 · 5 comments
Assignees
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. telemetry x/telemetry issues
Milestone

Comments

@findleyr
Copy link
Member

findleyr commented Nov 1, 2023

We need canonical documentation for Go telemetry: what it is (+what it is not), why does it exist, how does it work, how do you use it, etc.

  • telemetry.go.dev/privacy is canonical, but only discusses privacy related issues
  • @rsc's blog posts give a thorough overview, but are lengthy, don't reflect the current status, and aren't living documents

We discussed, and decided to add a new page on go.dev to host this documentation: go.dev/doc/telemetry.

@gopherbot gopherbot added the telemetry x/telemetry issues label Nov 1, 2023
@gopherbot gopherbot added this to the Unreleased milestone Nov 1, 2023
@cherrymui cherrymui added the NeedsFix The path to resolution is known, but the work has not been done. label Nov 2, 2023
@findleyr findleyr self-assigned this Jan 23, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/558196 mentions this issue: _content/doc: add canonical documentation for Go telemetry

gopherbot pushed a commit to golang/website that referenced this issue Mar 11, 2024
Add documentation for Go telemetry, aimed at Go users who want to
understand telemetry better. This article goes into some detail about
the telemetry data flow, but doesn't get into details about x/telemetry
APIs, as those are mostly interesting only for Go toolchain developers,
and therefore belong in x/telemetry documentation.

For golang/go#63883

Change-Id: Ie7e82960a2dbe5e0c0c81e46dc0b0c86174365fe
Reviewed-on: https://go-review.googlesource.com/c/website/+/558196
Reviewed-by: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Russ Cox <rsc@golang.org>
Auto-Submit: Robert Findley <rfindley@google.com>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/570677 mentions this issue: gopls/internal/server: update telmetry prompt link

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/570598 mentions this issue: [gopls-release-branch.0.15] gopls/internal/server: update telmetry prompt link

gopherbot pushed a commit to golang/tools that referenced this issue Mar 11, 2024
Now that go.dev/doc/telemetry exists, use it as a better link for
information about go telemetry.

For golang/go#63883

Change-Id: Ibe561c435e648b324a5ac444a8aade953354e92b
Reviewed-on: https://go-review.googlesource.com/c/tools/+/570677
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
gopherbot pushed a commit to golang/tools that referenced this issue Mar 11, 2024
…rompt link

Now that go.dev/doc/telemetry exists, use it as a better link for
information about go telemetry.

For golang/go#63883

Change-Id: Ibe561c435e648b324a5ac444a8aade953354e92b
Reviewed-on: https://go-review.googlesource.com/c/tools/+/570598
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/570601 mentions this issue: _content/doc/telemetry: use a solid background for dataflow diagram

gopherbot pushed a commit to golang/website that referenced this issue Mar 11, 2024
The transparent background for dataflow.png did not work well with a
dark theme. Use a solid white background.

For golang/go#63883

Change-Id: I9836522d3411125037dd70502c0dfe690a786157
Reviewed-on: https://go-review.googlesource.com/c/website/+/570601
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/572895 mentions this issue: _content/doc/telemetry.md: update links to newly renamed chartconfig

@golang golang locked and limited conversation to collaborators Mar 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. telemetry x/telemetry issues
Projects
None yet
Development

No branches or pull requests

3 participants