docs: Document telemetry #4972
docs: Document telemetry #4972
Conversation
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
Dan-Heath
added
the
backport/website
| Complete the following steps to configure events: | ||
|
|
||
| 1. Open the configuration file for the controller or worker server that you want to emit events. | ||
| 1. Edit the `events` stanza in the configuration file. |
There was a problem hiding this comment.
I think this should be item 2
There was a problem hiding this comment.
Ah yeah, our Markdown standard is a little wonky. That still renders as numbers 2 and 3. It should be OK in the preview deployment:
| Learn what data Boundary captures when telemetry is enabled and how you can view it. | ||
| --- | ||
|
|
||
| # Telemetry data |
There was a problem hiding this comment.
Is this going to be an internal doc?
There was a problem hiding this comment.
No, Anando wants to publish these steps for our external users so they can benefit from telemetry. So we would publish this to developer.com with our other external docs.
There was a problem hiding this comment.
Got it thanks for clarifying Dan
| <td>Auth method URI</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Link (Includes location: org ID, project ID, and internal ID)</td> |
There was a problem hiding this comment.
I believe the link is only available to us because we append them into the telemetry events when we are processing them in cloud boundary service. so boundary user wont see this information when they turn on the telemetry
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td rowspan="10">HCP Boundary clusters created</td> |
There was a problem hiding this comment.
This is internal as well. only visible to us. customer won't be able to see this.
Added 2 new pages to expand on Boundary's telemetry capabilities:
And edited the existing index page to provide additional info and reduce redundancy: