Adjustable Pebble health check timeout

weiiwang01 commented 2 months ago

Overview

Introduce a new configuration option, health_check_timeout_seconds, to customize the timeout value for WordPress in Pebble. Operators can use this setting to modify the threshold for health checks, tailoring it to the expected system performance and environmental conditions.

Checklist

[x] The charm style guide was applied
[x] The contributing guide was applied
[x] The changes are compliant with ISD054 - Managing Charm Complexity
[x] The documentation is generated using src-docs
[x] The documentation for charmhub is updated.
[x] The PR is tagged with appropriate label (urgent, trivial, complex)

weiiwang01 commented 2 months ago

LGTM, could you please use the pull request template?

Gotcha, I have update the pull request description based on your recommendations, thanks!

github-actions[bot] commented 2 months ago

Test coverage for 0041e6e6f266cf3073ddea60793ab2fdc2d0a4b4

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/charm.py          556     35    190     34    91%   162, 204-207, 299->302, 414, 473->477, 626, 657, 663, 680-684, 714, 749-750, 808, 817, 921->934, 933, 935, 940-941, 1001, 1021, 1028, 1118, 1127, 1139, 1160, 1169, 1188, 1192, 1221, 1262, 1394, 1416, 1423->1425, 1468->exit, 1480, 1490, 1528
src/cos.py             20      0      0      0   100%
src/exceptions.py      16      1      2      1    89%   41
src/state.py           33      0      4      0   100%
src/types_.py          15      0      0      0   100%
---------------------------------------------------------------
TOTAL                 640     36    196     35    92%

Static code analysis report

Run started:2024-09-11 11:30:47.554258

Test results:
    No issues identified.

Code scanned:
    Total lines of code: 4642
    Total lines skipped (#nosec): 1
    Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
    Total issues (by severity):
        Undefined: 0
        Low: 0
        Medium: 0
        High: 0
    Total issues (by confidence):
        Undefined: 0
        Low: 0
        Medium: 0
        High: 0
Files skipped (0):

hloeung commented 2 months ago

Unfortunately with this change, we still can't bump the timeout:

ops.pebble.APIError: plan check "wordpress-ready" timeout must be less than period

I think we need a bit to override and increase period1 as well.

canonical / wordpress-k8s-operator

Adjustable Pebble health check timeout #238

Overview

Checklist