Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

doc/telemetry: add exported events schema #57106

Merged
merged 11 commits into from
Sep 28, 2023

Conversation

bobheadxi
Copy link
Member

@bobheadxi bobheadxi commented Sep 27, 2023

This adds a generated markdown reference (thanks @burmudar!) that can serve as a source-of-truth for exactly what data we do and don't export from Sourcegraph instances.

Test plan

bazel run //doc/dev/background-information/telemetry:write_telemetrygateway_doc

Preview of what that looks like: https://github.com/sourcegraph/sourcegraph/blob/09-27-telemetry_generate_export_schema/doc/dev/background-information/telemetry/protocol.md

Output is a little funky, unless pseudomuto/protoc-gen-doc#520 gets landed one day (for that new br template function)

Preview 🤩

Preview Link

@cla-bot cla-bot bot added the cla-signed label Sep 27, 2023
@bobheadxi bobheadxi changed the base branch from main to 09-27-telemetry_improve_inline_docstrings September 27, 2023 22:48
@bobheadxi
Copy link
Member Author

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@bobheadxi bobheadxi force-pushed the 09-27-telemetry_generate_export_schema branch 6 times, most recently from fde90c0 to 0613cc8 Compare September 27, 2023 23:12
go.mod Outdated Show resolved Hide resolved
go.mod Outdated Show resolved Hide resolved
Base automatically changed from 09-27-telemetry_improve_inline_docstrings to main September 28, 2023 16:52
@bobheadxi bobheadxi force-pushed the 09-27-telemetry_generate_export_schema branch from 5969090 to d791d4e Compare September 28, 2023 17:00
@bobheadxi bobheadxi changed the title 09 27 telemetry generate export schema doc/telemetry: add exported events schema Sep 28, 2023
@bobheadxi bobheadxi marked this pull request as ready for review September 28, 2023 17:01
@bobheadxi bobheadxi requested review from nathan-downs, a team and dadlerj September 28, 2023 17:01
@bobheadxi bobheadxi merged commit 3efaaf9 into main Sep 28, 2023
6 checks passed
@bobheadxi bobheadxi deleted the 09-27-telemetry_generate_export_schema branch September 28, 2023 20:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants