Skip to content

Add / Document secureCodeBox Operator Prometheus Metrics#2581

Merged
Ilyesbdlala merged 13 commits intosecureCodeBox:mainfrom
J12934:operator-metrics
Jul 23, 2024
Merged

Add / Document secureCodeBox Operator Prometheus Metrics#2581
Ilyesbdlala merged 13 commits intosecureCodeBox:mainfrom
J12934:operator-metrics

Conversation

@J12934
Copy link
Copy Markdown
Member

@J12934 J12934 commented Jul 18, 2024 •
edited
Loading

Description

  • Add integration / helm value to let prometheus scrape secureCodeBox operator metrics
  • Document operator metrics / where to configure them
  • Add three custom metrics to begin with to track how many scans per scan_type were created and succeeded / failed
    • Refactored Scan status for this to a enum to better allow to track all "state" transitions

Closes #2580

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure that all your commits are signed-off and that you are added to the Contributors file.
  • Make sure that all CI finish successfully.
  • Optional (but appreciated): Make sure that all commits are Verified.

@J12934 J12934 added enhancement New feature or request go Pull requests that update Go code labels Jul 18, 2024
@J12934 J12934 self-assigned this Jul 18, 2024
@netlify
Copy link
Copy Markdown

netlify bot commented Jul 18, 2024 •
edited
Loading

✅ Deploy Preview for docs-securecodebox canceled.

Name Link
🔨 Latest commit 3465e1d
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/669a029ddc691b00085eed28

Weltraumschaf
Weltraumschaf reviewed Jul 18, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@Weltraumschaf Weltraumschaf left a comment

Choose a reason for hiding this comment

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

See my suggestions/comments.

J12934 and others added 10 commits July 19, 2024 07:56
@J12934
Fix minor linting warnings
bbc3512 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
Extract scan state into a enum / typed string
ecbf1af 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Write metrics for started, done and errored scans
f6226b4 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Delete unused cluster roles
3ab30bd 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Remove extra whitespaces
6855af2 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Add option to configure prometheus operator servic…
ef8f47b 
…e monitor via operator chart

Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Add snapshot test for operator metrics
2b01f1c 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Generate new helm docs table entries
e7f1bb0 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
secureCodeBox#2580 Add missing copyright header
77efb88 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934 @Weltraumschaf
Minor spelling consistency changes
583ab2a 
Co-authored-by: Sven Strittmatter <ich@weltraumschaf.de>
Signed-off-by: Jannik Hollenbach <jannik@hollenbach.de>
@J12934 J12934 force-pushed the operator-metrics branch from 9c670c0 to 583ab2a Compare July 19, 2024 05:56
J12934 added 3 commits July 19, 2024 08:00
@J12934
Remove duplicated scan state enum
e162cc9 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
Update imports as it was renamed in another pr
cf8c7f1 
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
@J12934
Change whitespacing mode for if so that the first rendered out line d…
3465e1d 
…oesn't get pulled into the comment
@J12934 J12934 requested a review from Weltraumschaf July 19, 2024 06:08
@Ilyesbdlala Ilyesbdlala merged commit 00f4a65 into secureCodeBox:main Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Weltraumschaf Weltraumschaf Weltraumschaf approved these changes

Assignees

@J12934 J12934

Labels

enhancement New feature or request go Pull requests that update Go code

Projects

secureCodeBox
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Prometheus Metrics for the secureCodeBox Operator

3 participants

@J12934 @Weltraumschaf @Ilyesbdlala