← Back to issue list

docs: Add 12-factor how-to on using observability

View original Github issue

Metadata

Project
charmcraft
Number
#2232
Type
pull request
State
merged
Author
erinecon
Labels
—
Created
Updated
Closed

Current evaluation

Docs PR merged as commit 4a6de71a: adds a "Use observability" how-to (Grafana dashboards, app logs) to the 12-factor app guide, an integrate_web_app_cos section target, and Flask/Django reference updates.

Resolution: closed resolved

Reason: The PR itself was merged into main as commit 4a6de71a ("docs: Add 12-factor how-to on using observability (#2232)"), approved by 3 reviewers. The added content is present in the tree at docs/howto/manage-web-app-charms/use-web-app-charm.rst (target _use-12-factor-charms-observability) and the integrate_web_app_cos target in integrate-web-app-charm.rst.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### Summary of changes * Add a new section, "Use observability" on how to access the dashboards and view application logs. * Tweak titles of other usage-related how-to's in the same file. * Add a section target on "Integrate with observability". * Based on the PR review, updated the Flask and Django reference pages. Additional reviewer: @jdkandersson

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs PR merged as commit 4a6de71a: adds a "Use observability" how-to (Grafana dashboards, app logs) to the 12-factor app guide, an integrate_web_app_cos section target, and Flask/Django reference updates.
stealth/space-bunny-alpha — closed resolved Merged docs update adds a 12-factor observability how-to covering dashboards and application logs, with link targets and Flask/Django reference updates.
qwen/qwen3.6-35b-a3b — — Merged documentation adding a 12-factor observability how-to guide for dashboards and logs. Updated related titles and Flask/Django references. Approved by three reviewers, merged with a +114/-4 line change across four files.
qwen3.6-35b-a3b-mtp-q6 — — Merged 12-factor observability how-to covering dashboards and logs. Adjusted related how-to titles, added section targets, and updated Flask and Django reference pages per review.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2489 (confidence 60%)

    Follow-up 'docs: add targets for intersphinx linking' further extends the section targets introduced by #2232.

  • Related To: canonical/charmcraft#2246 (confidence 55%)

    Adjacent 12-factor how-to work adding a troubleshooting section to the same guide shortly after #2232.

  • Related To: canonical/charmcraft#2742 (confidence 45%)

    'docs: 12 factor v2' later restructures the same how-to file that #2232 edited.

Related issues

Issue Project State Summary Similarity
#2219 Docs: Add 12-factor how-to sections for integrations charmcraft merged Merged as 69dd1326, adding database, ingress, and observability integration sections to the 12-factor web-app charm how-to.
74%
#2352 docs: update 12-factor how-to guide on async apps charmcraft merged Merged as commit 43dc21be, updating the async Flask 12-factor guide to cover Django, clarify app naming, label requirements.txt, and recommend status monitoring.
70%