Skip to content

Adjust the charm logging to include the logger name#550

Draft
addyess wants to merge 8 commits intomainfrom
akd/improved-logging
Draft

Adjust the charm logging to include the logger name#550
addyess wants to merge 8 commits intomainfrom
akd/improved-logging

Conversation

@addyess
Copy link
Copy Markdown
Contributor

@addyess addyess commented Jul 2, 2025 •
edited
Loading

Overview

  • Adjusts the charm logging to include logger name

Details

  • ops sets up a logger in ops.log but it uses the default Formatter
  • Adjust the formatter to use a Custom Formatter

DIff of a few logs:

- unit-k8s-0: 13:05:35 INFO unit.k8s/0.juju-log k8s/0(juju-04ff10-noble-0) current cluster-name=k8s-bd08d4f998c4e658c2c4139659f824ac
- unit-k8s-0: 13:06:24 INFO unit.k8s/0.juju-log Feature 'load-balancer' enabled=False,deployed=False,ver=v0.14.9-ck0,updated_at=2025-07-01 22:01:42+00:00: disabled
+ unit-k8s-0: 13:05:35 INFO unit.k8s/0.juju-log __main__:384 k8s/0(juju-04ff10-noble-0) current cluster-name=k8s-bd08d4f998c4e658c2c4139659f824ac
+ unit-k8s-0: 13:06:24 INFO unit.k8s/0.juju-log events.update_status:128 Feature 'load-balancer' enabled=False,deployed=False,ver=v0.14.9-ck0,updated_at=2025-07-01 22:01:42+00:00: disabled

@addyess addyess requested a review from a team as a code owner July 2, 2025 18:06
mateoflorido
mateoflorido approved these changes Jul 2, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@mateoflorido mateoflorido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! Thanks @addyess

@addyess addyess marked this pull request as draft July 2, 2025 20:35
@addyess
Copy link
Copy Markdown
Contributor Author

addyess commented Jul 2, 2025

Converted to draft waiting on feedback from ops
canonical/operator#1881

@addyess
Copy link
Copy Markdown
Contributor Author

addyess commented Jul 3, 2025

Converted to draft waiting on feedback from ops canonical/operator#1881

Nevermind -- the ops issue canonical/operator#1880 is still open -- but it didn't seem they wanted to PR

@addyess addyess marked this pull request as ready for review July 3, 2025 17:27
@addyess addyess force-pushed the akd/improved-logging branch from 72c382d to ef1a3b9 Compare July 3, 2025 17:28
@addyess addyess marked this pull request as draft July 21, 2025 18:30
@addyess addyess force-pushed the akd/improved-logging branch from 7f4168b to afdad26 Compare December 11, 2025 22:15
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 11, 2025

Test results for commit afdad26

Test coverage for afdad26

Name                                            Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------------------------------
charms/worker/k8s/src/certificates.py             187    187     44      0     0%   6-457
charms/worker/k8s/src/charm.py                    649    289    202     35    51%   121-122, 235-236, 246-247, 249, 263, 277-284, 307-312, 318-334, 371-374, 386, 395, 412-415, 420-422, 430-439, 462->467, 469-472, 506-507, 519->521, 526-528, 530-532, 544-558, 579, 587-593, 606-623, 639, 644-645, 655->exit, 677-693, 702-711, 723-735, 753-769, 779-794, 803-809, 821-863, 881-883, 885, 903-915, 924-951, 963-975, 985, 1027, 1030, 1039, 1049, 1052, 1062-1074, 1079-1085, 1107-1109, 1113-1116, 1127-1146, 1150-1151, 1171-1172, 1189, 1192-1193, 1199->1208, 1235-1238, 1241-1244, 1247-1250, 1256-1259, 1270-1271, 1274-1275
charms/worker/k8s/src/charmed_etcd.py              47     28      8      0    35%   32-36, 46, 57, 61-63, 67-81, 90-91, 95-102
charms/worker/k8s/src/cloud_integration.py         80      3     24      3    94%   140, 149->151, 158-159
charms/worker/k8s/src/config/arg_files.py          79      0     22      2    98%   134->133, 152->150
charms/worker/k8s/src/config/bootstrap.py         145     24     54      5    78%   65-84, 158-159, 202-203, 205, 223, 252, 266->254
charms/worker/k8s/src/config/cluster.py            63      3     22     11    84%   37, 51->53, 59->61, 63->65, 66, 68, 73->75, 79->81, 85->87, 92->94, 98->100
charms/worker/k8s/src/config/extra_args.py         43      4     20      4    87%   32->27, 44, 82, 100, 116
charms/worker/k8s/src/config/option.py             20      0      8      0   100%
charms/worker/k8s/src/config/resource.py           33      7      4      1    73%   32, 57-58, 63-72
charms/worker/k8s/src/containerd.py               154     15     48     18    83%   45-48, 78->82, 82->85, 85->88, 234->236, 240->243, 243->245, 245->247, 247->250, 262, 269, 276, 327-328, 340-341, 355, 357, 359, 363
charms/worker/k8s/src/cos_integration.py           41     16      4      0    56%   82, 117-234, 238
charms/worker/k8s/src/endpoints.py                 40      1     18      1    97%   62
charms/worker/k8s/src/events/update_status.py     104     19     32      9    78%   93, 99-100, 124, 126, 142, 156-167, 173, 191, 192->194, 198
charms/worker/k8s/src/inspector.py                 62     10     24      6    79%   44-45, 74, 109, 122-123, 132, 138-143
charms/worker/k8s/src/k8s/client.py                20      4      2      1    77%   39->41, 47-48, 50-51
charms/worker/k8s/src/k8s/node.py                  34     14      4      0    53%   47-49, 52, 65-75
charms/worker/k8s/src/k8sd_api_manager.py         411     27     14      2    93%   712, 787-788, 1019, 1062-1064, 1073-1077, 1139, 1208, 1216, 1234, 1247-1248, 1309-1311, 1322-1325, 1342-1346
charms/worker/k8s/src/kube_control.py              44     32     10      0    22%   31-35, 44-90
charms/worker/k8s/src/literals.py                 114      0      0      0   100%
charms/worker/k8s/src/pki.py                       29      9      2      1    68%   35-36, 49-54, 65
charms/worker/k8s/src/protocols.py                 33      5      0      0    85%   60, 68, 76, 84, 92
charms/worker/k8s/src/reschedule.py                79      4      6      3    92%   155->158, 174-175, 191-192, 215->exit, 221->exit
charms/worker/k8s/src/snap.py                     180     16     58     11    89%   110, 188-189, 200-201, 214->207, 232-237, 291-292, 294, 297->288, 304->288, 308, 329-330
charms/worker/k8s/src/token_distributor.py        251    129     66      7    43%   112-114, 128, 182, 186, 211, 236->exit, 267, 287-288, 301-311, 332, 348-361, 407->406, 411, 415->420, 438-472, 506, 519, 529, 550-660, 679-732, 745-747
charms/worker/k8s/src/upgrade.py                  121     38     36      5    64%   81-108, 191->193, 202-205, 208-212, 219->221, 222-225, 242
charms/worker/k8s/src/utils.py                     23     12      8      1    45%   29-50, 59
-------------------------------------------------------------------------------------------
TOTAL                                            3086    896    740    126    67%

Static code analysis report

Run started:2025-12-11 22:16:17.224297+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 6184
  Total lines skipped (#nosec): 4
  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):

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 11, 2025

Test results for commit afdad26

Test coverage for afdad26

Name                                            Stmts   Miss Branch BrPart  Cover   Missing
-------------------------------------------------------------------------------------------
charms/worker/k8s/src/certificates.py             187    187     44      0     0%   6-457
charms/worker/k8s/src/charm.py                    649    289    202     35    51%   121-122, 235-236, 246-247, 249, 263, 277-284, 307-312, 318-334, 371-374, 386, 395, 412-415, 420-422, 430-439, 462->467, 469-472, 506-507, 519->521, 526-528, 530-532, 544-558, 579, 587-593, 606-623, 639, 644-645, 655->exit, 677-693, 702-711, 723-735, 753-769, 779-794, 803-809, 821-863, 881-883, 885, 903-915, 924-951, 963-975, 985, 1027, 1030, 1039, 1049, 1052, 1062-1074, 1079-1085, 1107-1109, 1113-1116, 1127-1146, 1150-1151, 1171-1172, 1189, 1192-1193, 1199->1208, 1235-1238, 1241-1244, 1247-1250, 1256-1259, 1270-1271, 1274-1275
charms/worker/k8s/src/charmed_etcd.py              47     28      8      0    35%   32-36, 46, 57, 61-63, 67-81, 90-91, 95-102
charms/worker/k8s/src/cloud_integration.py         80      3     24      3    94%   140, 149->151, 158-159
charms/worker/k8s/src/config/arg_files.py          79      0     22      2    98%   134->133, 152->150
charms/worker/k8s/src/config/bootstrap.py         145     24     54      5    78%   65-84, 158-159, 202-203, 205, 223, 252, 266->254
charms/worker/k8s/src/config/cluster.py            63      3     22     11    84%   37, 51->53, 59->61, 63->65, 66, 68, 73->75, 79->81, 85->87, 92->94, 98->100
charms/worker/k8s/src/config/extra_args.py         43      4     20      4    87%   32->27, 44, 82, 100, 116
charms/worker/k8s/src/config/option.py             20      0      8      0   100%
charms/worker/k8s/src/config/resource.py           33      7      4      1    73%   32, 57-58, 63-72
charms/worker/k8s/src/containerd.py               154     15     48     18    83%   45-48, 78->82, 82->85, 85->88, 234->236, 240->243, 243->245, 245->247, 247->250, 262, 269, 276, 327-328, 340-341, 355, 357, 359, 363
charms/worker/k8s/src/cos_integration.py           41     16      4      0    56%   82, 117-234, 238
charms/worker/k8s/src/endpoints.py                 40      1     18      1    97%   62
charms/worker/k8s/src/events/update_status.py     104     19     32      9    78%   93, 99-100, 124, 126, 142, 156-167, 173, 191, 192->194, 198
charms/worker/k8s/src/inspector.py                 62     10     24      6    79%   44-45, 74, 109, 122-123, 132, 138-143
charms/worker/k8s/src/k8s/client.py                20      4      2      1    77%   39->41, 47-48, 50-51
charms/worker/k8s/src/k8s/node.py                  34     14      4      0    53%   47-49, 52, 65-75
charms/worker/k8s/src/k8sd_api_manager.py         411     27     14      2    93%   712, 787-788, 1019, 1062-1064, 1073-1077, 1139, 1208, 1216, 1234, 1247-1248, 1309-1311, 1322-1325, 1342-1346
charms/worker/k8s/src/kube_control.py              44     32     10      0    22%   31-35, 44-90
charms/worker/k8s/src/literals.py                 114      0      0      0   100%
charms/worker/k8s/src/pki.py                       29      9      2      1    68%   35-36, 49-54, 65
charms/worker/k8s/src/protocols.py                 33      5      0      0    85%   60, 68, 76, 84, 92
charms/worker/k8s/src/reschedule.py                79      4      6      3    92%   155->158, 174-175, 191-192, 215->exit, 221->exit
charms/worker/k8s/src/snap.py                     180     16     58     11    89%   110, 188-189, 200-201, 214->207, 232-237, 291-292, 294, 297->288, 304->288, 308, 329-330
charms/worker/k8s/src/token_distributor.py        251    129     66      7    43%   112-114, 128, 182, 186, 211, 236->exit, 267, 287-288, 301-311, 332, 348-361, 407->406, 411, 415->420, 438-472, 506, 519, 529, 550-660, 679-732, 745-747
charms/worker/k8s/src/upgrade.py                  121     38     36      5    64%   81-108, 191->193, 202-205, 208-212, 219->221, 222-225, 242
charms/worker/k8s/src/utils.py                     23     12      8      1    45%   29-50, 59
-------------------------------------------------------------------------------------------
TOTAL                                            3086    896    740    126    67%

Static code analysis report

Run started:2025-12-11 22:16:18.325887+00:00

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 6184
  Total lines skipped (#nosec): 4
  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):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mateoflorido mateoflorido mateoflorido approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@addyess @mateoflorido