Skip to content

[*] update docs for metrics yaml folder configs#892

Merged
pashagolub merged 3 commits intocybertec-postgresql:masterfrom
0xgouda:add-test-for-metrics-folder
Aug 20, 2025
Merged

[*] update docs for metrics yaml folder configs#892
pashagolub merged 3 commits intocybertec-postgresql:masterfrom
0xgouda:add-test-for-metrics-folder

Conversation

@0xgouda
Copy link
Copy Markdown
Collaborator

@0xgouda 0xgouda commented Aug 15, 2025

  • add note in docs about yaml folder based configs being read-only
  • mention using yaml-folder for metrics configs in docs

@coveralls
Copy link
Copy Markdown

coveralls commented Aug 15, 2025

Pull Request Test Coverage Report for Build 17067856327

Details

  • 125 of 142 (88.03%) changed or added relevant lines in 2 files are covered.
  • 16 unchanged lines in 3 files lost coverage.
  • Overall coverage increased (+0.4%) to 64.416%

Changes Missing Coverage Covered Lines Changed/Added Lines %
internal/metrics/yaml.go 120 137 87.59%
Files with Coverage Reduction New Missed Lines %
internal/cmdopts/cmdconfig.go 2 74.24%
internal/cmdopts/cmdmetric.go 4 92.31%
internal/metrics/yaml.go 10 85.04%
Totals Coverage Status
Change from base Build 17067698965: 0.4%
Covered Lines: 3320
Relevant Lines: 5154

💛 - Coveralls

@pashagolub pashagolub self-assigned this Aug 19, 2025
@pashagolub
Copy link
Copy Markdown
Collaborator

Since #891 is rejected this PR should be updated accordingly

@pashagolub pashagolub added documentation Improvements or additions to documentation test New test case or request metrics Metrics related issues labels Aug 19, 2025
@0xgouda 0xgouda force-pushed the add-test-for-metrics-folder branch from be86e81 to b79a55d Compare August 19, 2025 17:36
@0xgouda 0xgouda changed the title [*] add tests for using folder of yaml files as metrics config [*] update docs for metrics yaml folder configs Aug 19, 2025
@0xgouda
Copy link
Copy Markdown
Collaborator Author

0xgouda commented Aug 19, 2025

Since #891 is rejected this PR should be updated accordingly

@pashagolub

The PR has been updated, it now only updates docs for metrics yaml-folder configs, as tests for using yaml folder has already been provided #889

Also noting that the docs mention env vars being usable for sources and metrics yaml setups, this logic is not implemented for metrics yaml configs, but idk if this is an actual bug or there is no need for supporting the use of envs in metrics yaml files and we only need to update the docs to mention that this is sources only feature?.

@pashagolub
Copy link
Copy Markdown
Collaborator

Yeah, I cannot imagine how to use envvar in metric. So it's better to update docs

@0xgouda
Copy link
Copy Markdown
Collaborator Author

0xgouda commented Aug 19, 2025

Yeah, I cannot imagine how to use envvar in metric. So it's better to update docs

done.

@pashagolub pashagolub removed test New test case or request metrics Metrics related issues labels Aug 20, 2025
@pashagolub pashagolub force-pushed the add-test-for-metrics-folder branch from a37bae7 to c9040c3 Compare August 20, 2025 08:04
@pashagolub
Copy link
Copy Markdown
Collaborator

Thanks! Well done!

@pashagolub pashagolub merged commit 89f36b4 into cybertec-postgresql:master Aug 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants