NETOBSERV-2655: additionalIncludeList field to append metrics to default

[Amoghrd]

Description

Adds a new additionalIncludeList field to allow appending metrics to the defaults without breaking backward compatibility.

Problem: The original includeList field overwrites the default metrics list. Users who want to add a few extra metrics need to specify all defaults + their additions, which is cumbersome.

Solution:

• Keep includeList behavior unchanged (overwrites defaults) - backwards compatible
• Add new additionalIncludeList field that appends to defaults
• Fields are mutually exclusive - if both are set, includeList takes precedence and a validation warning is shown

Usage Examples:

Append to defaults:

spec:
  processor:
    metrics:
      additionalIncludeList:
        - namespace_egress_bytes_total
        - namespace_ingress_bytes_total

Override defaults (existing behavior):

spec:
  processor:
    metrics:
      includeList:
        - node_ingress_bytes_total

Changes

• Added additionalIncludeList field to FLPMetrics API
• Updated GetIncludeList() to support the new field
• Added validation to warn when both fields are set
• Added comprehensive tests for new functionality
• Updated CRDs, bundle, and documentation

Dependencies

n/a

Checklist

• Does the changes in PR need specific configuration or environment set up for testing?
  • if so please describe it in PR description.
• I have added thorough unit tests for the change.
• QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

[openshift-ci-robot]

@Amoghrd: This pull request references NETOBSERV-2655 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Description

Instead of overwriting metrics when added to includeList, now we append them to the default list.
Also updated the tests based on these changes

Dependencies

n/a

Checklist

• Does the changes in PR need specific configuration or environment set up for testing?
  • if so please describe it in PR description.
• I have added thorough unit tests for the change.
• QE requirements (check 1 from the list):
• Standard QE validation, with pre-merge tests unless stated otherwise.
• Regression tests only (e.g. refactoring with no user-facing change).
• No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[codecov]

Codecov Report

❌ Patch coverage is 66.66667% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.11%. Comparing base (3a14443) to head (8f898d8).
⚠️ Report is 15 commits behind head on main.

Files with missing lines	Patch %	Lines
api/flowcollector/v1beta2/zz_generated.deepcopy.go	0.00%	6 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2546      +/-   ##
==========================================
- Coverage   72.14%   72.11%   -0.03%     
==========================================
  Files         105      105              
  Lines       10762    10783      +21     
==========================================
+ Hits         7764     7776      +12     
- Misses       2517     2525       +8     
- Partials      481      482       +1     

Flag	Coverage Δ
unittests	72.11% <66.66%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...flowcollector/v1beta2/flowcollector_alert_types.go	97.72% <100.00%> (+0.13%)	⬆️
api/flowcollector/v1beta2/flowcollector_types.go	100.00% <ø> (ø)
...lector/v1beta2/flowcollector_validation_webhook.go	72.83% <100.00%> (+0.74%)	⬆️
api/flowcollector/v1beta2/zz_generated.deepcopy.go	35.58% <0.00%> (-0.26%)	⬇️

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jotak]

We can't change the behaviour of the existing API, it would be a breaking change.
We need instead to create a new setting, such as "additionalIncludeList", and keep the existing as it is.

[Amoghrd]

Sounds good, will do that

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from jotak. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• DOWNSTREAM_OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci-robot]

@Amoghrd: This pull request references NETOBSERV-2655 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

@/tmp/pr_body.md

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[jotak]

just a small comment, LGTM otherwise

[jotak]

Thanks @Amoghrd , lgtm

[oliver-smakal]

/ok-to-test

[github-actions]

New images:

quay.io/netobserv/network-observability-operator:aa88674
quay.io/netobserv/network-observability-operator-bundle:v0.0.0-sha-aa88674
quay.io/netobserv/network-observability-operator-catalog:v0.0.0-sha-aa88674

They will expire in two weeks.

To deploy this build:

# Direct deployment, from operator repo
IMAGE=quay.io/netobserv/network-observability-operator:aa88674 make deploy

# Or using operator-sdk
operator-sdk run bundle quay.io/netobserv/network-observability-operator-bundle:v0.0.0-sha-aa88674

Or as a Catalog Source:

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: netobserv-dev
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/netobserv/network-observability-operator-catalog:v0.0.0-sha-aa88674
  displayName: NetObserv development catalog
  publisher: Me
  updateStrategy:
    registryPoll:
      interval: 1m