prometheus: add scrapeInterval #595

evenh · 2025-02-04T15:30:35Z

Summary by CodeRabbit

New Features
- Introduced a configurable scrape interval for Prometheus monitoring with a default of 60 seconds, now available in application and job configurations.
- Added new resource definitions for enhanced monitoring setups, including customizable interval settings.
Refactor
- Streamlined internal resource generation and logging processes to improve monitoring configuration.
Tests
- Expanded test coverage to validate custom interval configurations and ensure proper handling of both valid and invalid settings.

coderabbitai · 2025-02-04T15:30:43Z

Walkthrough

This update introduces a new field, ScrapeInterval, to the Prometheus configuration in the API and CRD definitions. It updates monitoring configurations across ServiceMonitor, PodMonitor, and SKIPJob YAML files by standardizing scraping intervals, generally setting them to "60s" or custom values. The changes also adjust import statements and logging settings in controllers and resource generators, shifting resource generation logic from ServiceMonitor/PodMonitor to Prometheus-based functions. Additional tests have been added to validate both valid and invalid custom interval configurations.

Changes

File(s)	Change Summary
`api/v1alpha1/application_types.go` `config/crd/skiperator.kartverket.no_applications.yaml` `config/crd/skiperator.kartverket.no_skipjobs.yaml`	Added a new `scrapeInterval` (or `ScrapeInterval`) field with validation rules to PrometheusConfig and CRDs to standardize scrape intervals.
`tests/application/service-monitor/*.yaml` (application-istio-assert.yaml, application-simple-assert.yaml, patch-application-allowall-assert.yaml, application-simple-custom-interval(.yaml/invalid).yaml, chainsaw-test.yaml)	Updated or added `interval` fields, typically set to "60s" or custom values (e.g. "90s"), and applied minor formatting fixes in ServiceMonitor and Application configurations.
`tests/skipjob/podmonitor/*.yaml` (patch-skipjob-remove-monitoring-error.yaml, patch-skipjob-with-monitoring-assert.yaml, skipjob-with-monitoring-assert.yaml, chainsaw-test.yaml, patch-skipjob-with-monitoring-custom-interval(.yaml/assert).yaml)	Adjusted `interval` values—from "30s" to "60s" or to custom values like "100s"—and introduced a new Job and PodMonitor resource for SKIPJob monitoring.
`cmd/skiperator/main.go` `internal/controllers/application.go` `internal/controllers/skipjob.go`	Modified logging configuration by adding `DestWriter: os.Stdout`, updated import references, and shifted resource generation calls from ServiceMonitor/PodMonitor to Prometheus functions.
`pkg/resourcegenerator/prometheus/*.go` (pod_monitor.go, prometheus.go, service_monitor.go)	Renamed packages (from podmonitor/servicemonitor to prometheus), restructured generator functions (e.g. replacing `Generate` with an `init` function and new generation helpers), and introduced dedicated Prometheus resource generation logic.

Sequence Diagram(s)

sequenceDiagram
    participant AR as ApplicationReconciler
    participant PG as Prometheus Generator
    participant K8s as Kubernetes API
    AR->>PG: Call Generate(reconciliation)
    PG->>K8s: Create/Update Prometheus resource (ServiceMonitor/PodMonitor)
    K8s-->>PG: Return resource status
    PG-->>AR: Generation complete

sequenceDiagram
    participant SR as SKIPJobReconciler
    participant PG as Prometheus Generator
    participant K8s as Kubernetes API
    SR->>PG: Invoke generateForSkipJob(reconciliation)
    PG->>K8s: Create/Update monitoring resource for SKIPJob
    K8s-->>PG: Acknowledge update
    PG-->>SR: Return completion status

Possibly related PRs

Istio: Upgrade to V1 of APIs #555: Updates related to CRD enhancements for applications that adjust Prometheus configuration settings, including scrape intervals.
Create telemetry resource by default for applications #529: Modifications introducing an IstioSettings field in the ApplicationSpec struct, which also affect monitoring configuration options alongside the new scrape interval changes.

Suggested reviewers

martinhny
SnorreSelmer
berg-thom
omaen

Poem

I'm a rabbit with a code-filled day,
Hopping through YAML in a gleeful way,
New fields and intervals hop into sight,
Prometheus monitors by day and night.
Logs twinkle like stars, so bright and keen,
Hoppity-hop—I'm living the dream!
🐇✨

Tip

🌐 Web search-backed reviews and chat

We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
You can disable this feature by setting web_search: false in the knowledge_base settings.
Please share any feedback in the Discord discussion.

✨ Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-02-04T15:30:48Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Files

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

pkg/resourcegenerator/podmonitor/pod_monitor.go (1)
4-6: Remove unused import.

The strings package is imported but not used in this file.
-import (
-	"fmt"
-	"strings"
-
-	skiperatorv1alpha1 "github.com/kartverket/skiperator/api/v1alpha1"
+import (
+	"fmt"
+	skiperatorv1alpha1 "github.com/kartverket/skiperator/api/v1alpha1"
tests/application/service-monitor/application-simple-assert.yaml (1)

104-105: Refined formatting for NetworkPolicy ports.
The update to the ports section in the NetworkPolicy—ensuring the - port: istio-metrics entry is clearly defined—enhances readability and maintains consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd6bdb5 and f627e9a.

📒 Files selected for processing (9)

api/v1alpha1/application_types.go (2 hunks)
pkg/resourcegenerator/podmonitor/pod_monitor.go (3 hunks)
pkg/resourcegenerator/servicemonitor/service_monitor.go (3 hunks)
tests/application/service-monitor/application-istio-assert.yaml (1 hunks)
tests/application/service-monitor/application-simple-assert.yaml (2 hunks)
tests/application/service-monitor/patch-application-allowall-assert.yaml (1 hunks)
tests/skipjob/podmonitor/patch-skipjob-remove-monitoring-error.yaml (1 hunks)
tests/skipjob/podmonitor/patch-skipjob-with-monitoring-assert.yaml (1 hunks)
tests/skipjob/podmonitor/skipjob-with-monitoring-assert.yaml (1 hunks)

🧰 Additional context used

🪛 GitHub Check: CRD and ClusterRole