Better telemetry docs - Githubissues

ryanuber commented 1 year ago

What

Adds details for telemetry data, including logs, tracing, and metrics. This change attempts to give good coverage of current metrics, without including any details which are subject to change, such as the tags and labels applied to each metric. This is intended to provide a basic inventory of metrics and high-level descriptions of what each measurement means.

Why

Multiple users have asked for this, and this follows the same general pattern for documenting metrics as taken by other products such as Nomad or Consul.

Screenshots

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

[x] One or more labels describe the type of change (e.g. clarification) and associated product (e.g. tfc).
[x] Description links to related pull requests or issues, if any.

Content

[x] Redirects have been added for moved, renamed, or deleted pages. This requires a separate PR in the terraform-website repository redirects.next.js file.
[x] API documentation and the API Changelog have been updated.
[x] Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
[x] Pages with related content are updated and link to this content when appropriate.
[x] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
[x] New pages have metadata (page name and description) at the top.
[x] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
[x] New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
[x] UI elements (button names, page names, etc.) are bolded.
[x] The Vercel website preview successfully deployed.

Reviews

[x] I or someone else reviewed the content for technical accuracy.
[x] I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
terraform-docs-agents	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Jan 31, 2023 at 10:19PM (UTC)

clairevnext commented 1 year ago

This is an amazing amount of data to get documented! 🎉 Thank you for all the time this must have taken.