docs: add monitoring chapter for status & prometheus#505
docs: add monitoring chapter for status & prometheus#505creativeprojects merged 1 commit intomasterfrom
Conversation
creativeprojects
commented
May 19, 2025
creativeprojects
commented
- add monitoring chapter for status & prometheus
- add aliases to link old status url back to new one
- add tags in documentation
- rephrased status and prometheus documentation
WalkthroughThe changes update documentation structure and content, refine configuration examples, and modify a method signature in the codebase. Documentation for monitoring features is reorganised and clarified, new metadata tags are introduced for better categorisation, and configuration hooks are expanded in an example YAML file. A method in the Go code is updated to improve integration with embedded logic. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant InitSection
participant GenericSection
participant Profile
User->>InitSection: setRootPath(Profile, rootPath)
InitSection->>GenericSection: setRootPath(Profile, rootPath)
GenericSection-->>InitSection: (returns)
InitSection->>InitSection: Fix FromRepositoryFile/FromPasswordFile paths
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure ✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/content/_index.md (2)
26-26: Update status file link to new monitoring path. The link has been changed to/monitoring/status, but for consistency with other relref usages, consider removing the leading slash:- * Generate a simple [status file]({{% relref "/monitoring/status" %}}) … + * Generate a simple [status file]({{% relref "monitoring/status" %}}) …
29-29: Update Prometheus link to new monitoring path. Similarly, remove the leading slash in the relref to match established conventions:- * Export a [prometheus]({{% relref "/monitoring/prometheus" %}}) … + * Export a [prometheus]({{% relref "monitoring/prometheus" %}}) …docs/content/monitoring/prometheus.md (1)
87-130: Missing code block language specifier.The fenced code block should specify the language for proper syntax highlighting. Additionally, the example has been helpfully updated with current version numbers and the addition of the missing
restic_build_infometric.-``` +```prometheus🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
87-87: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (9)
config/profile.go(1 hunks)docs/content/_index.md(1 hunks)docs/content/configuration/http_hooks.md(1 hunks)docs/content/configuration/run_hooks.md(1 hunks)docs/content/monitoring/_index.md(1 hunks)docs/content/monitoring/prometheus.md(3 hunks)docs/content/monitoring/status.md(3 hunks)docs/hugo.toml(1 hunks)examples/dev.yaml(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/content/monitoring/prometheus.md
87-87: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and test (1.24, windows-latest)
🔇 Additional comments (14)
docs/content/configuration/run_hooks.md (1)
4-4: Monitoring tag added to front matter. The inclusion oftags: [ "monitoring" ]correctly integrates this page into the monitoring taxonomy, improving its discoverability.docs/content/configuration/http_hooks.md (1)
4-4: Monitoring and healthchecks.io tags added to front matter. Thetagsarray now includes both"monitoring"and"healthchecks.io", enhancing categorisation and discoverability of HTTP hooks within the monitoring context.docs/hugo.toml (1)
43-46: Enable Tags shortcut in Hugo menu. Re-uncommenting theTagsmenu entry undermenu.shortcutsrestores navigation to/tags. Please verify that a/tagspage exists and is populated to prevent broken links.docs/content/monitoring/_index.md (1)
1-9: Add new Monitoring chapter index. This_index.mdcorrectly defines the "Monitoring" section with the appropriate archetype, prefix, title, weight, and{{% children %}}shortcode, establishing the documentation hierarchy for monitoring features.examples/dev.yaml (3)
132-139: Good addition of monitoring hooks to the check section.The implementation of both shell command hooks (
run-before,run-after) and HTTP hooks (send-before,send-after) provides a comprehensive example of how to monitor check operations. This aligns well with the monitoring documentation improvements.
140-148: Well-structured monitoring hooks for initialization.Adding similar hooks to the init section provides consistency and demonstrates how the same monitoring pattern can be applied across different operations. The examples showing both command-line notifications and HTTP requests are particularly helpful.
193-194: Consistent with documentation updates.Commenting out the
prometheus-labelssection aligns with the updated Prometheus documentation, which now shows this configuration as an alternative rather than a default approach.config/profile.go (1)
139-141: Improved root path handling.The change properly delegates to the embedded GenericSection's setRootPath method before applying specific path handling logic for the InitSection. This ensures consistent path resolution behaviour across different section types.
docs/content/monitoring/status.md (3)
1-8: Good metadata structure and backwards compatibility.The added frontmatter properly categorises this document with the "monitoring" tag and includes an alias to the old path (/status) for backward compatibility with existing links, which is a good practice.
10-14: Clear and concise introduction.The rewritten introduction provides a more direct and practical explanation of the status file functionality, with a clear distinction between using scripts for complex monitoring needs and the JSON status file for simpler cases.
97-109: Improved clarity on extended status limitations.The explanation of the extended status limitation and its impact on terminal output is now more concise and easier to understand. The added emphasis that extended-status is disabled by default because it suppresses output helps users make an informed decision.
docs/content/monitoring/prometheus.md (3)
1-9: Good documentation structure and introduction.The added frontmatter with proper tags and slug improves document organisation. The rewritten introduction is more concise and clearly explains the purpose of the Prometheus integration.
136-141: Clearer explanation of Prometheus Pushgateway behaviour.The description of how the job label works with Pushgateway and the explanation of the
prometheus-push-jobandprometheus-push-formatproperties are more precise and helpful for users configuring this feature.
142-144: Improved section heading and description.The renamed section "User-Defined Labels" (with proper hyphenation) and clearer explanation enhance the readability and professionalism of the documentation.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #505 +/- ##
=======================================
Coverage 79.33% 79.34%
=======================================
Files 134 134
Lines 13229 13231 +2
=======================================
+ Hits 10495 10497 +2
Misses 2316 2316
Partials 418 418
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
1 participant
