Skip to content

enhancements: add SEP for metrics integration#2028

Open
mayleighnmyers wants to merge 5 commits into
istio-ecosystem:mainfrom
mayleighnmyers:enhancements/sep3-observability
Open

enhancements: add SEP for metrics integration#2028
mayleighnmyers wants to merge 5 commits into
istio-ecosystem:mainfrom
mayleighnmyers:enhancements/sep3-observability

Conversation

@mayleighnmyers

Copy link
Copy Markdown

What type of PR is this?

  • [ X] Enhancement / New Feature
  • Bug Fix
  • Refactor
  • Optimization
  • Test
  • Documentation Update

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Related Issue/PR #
#1959

Additional information:

Signed-off-by: Mayleigh Tjapkes <mamyers@redhat.com>
@mayleighnmyers mayleighnmyers requested a review from a team as a code owner June 24, 2026 16:40
@istio-testing

Copy link
Copy Markdown
Collaborator

Hi @mayleighnmyers. Thanks for your PR.

I'm waiting for a istio-ecosystem or istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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 kubernetes-sigs/prow repository.

@fjglira

fjglira commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

/ok-to-test

Comment thread enhancements/SEP3-observability-integration.md Outdated
Comment thread enhancements/SEP8471-metrics-integration.md Outdated
Comment thread enhancements/SEP8471-metrics-integration.md
Comment thread enhancements/SEP8471-metrics-integration.md

A broader Observability Integration API with target references to a monitoring and tracing stacks is being discussed in the initial PR comments. We plan to design and implement the monitoring controller and broader Integration API controller separately. This enhancement proposal is focused on the monitoring controller with API change in the `Istio` Custom Resource. We will work toward a broader Integration API design and implementation in next phase.

### Architecture

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How will deletion be handled? I think it worth to mention how we plan to hanlde the deletion of the resources

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

There is a concern from existing environments where users have configured their custom ServiceMonitor or PodMontior resources manually. They expect those existing resources should not be deleted from Sail Operator.
We will add a paragraph about deletion in SEP. Thanks.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Checking ownership can help us to solve this? we can add specific metadata to allow us to easily filter which resources are handle by our operator

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

yes, that helps. Checking labels should also work when the monitoring controller creates those resources with a unique label such as managed-by: mesh-operator

@fjglira fjglira requested a review from dgn June 29, 2026 11:41
Signed-off-by: Mayleigh Tjapkes <mamyers@redhat.com>
@fjglira

fjglira commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

/retest


## Implementation Plan

v1alpha1

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

what does v1alpha1 mean in this case?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It refers to API changes we will introduce for enabling this controller. The initial plan was simply adding a spec.monitoring.enabled field in the existing Istio CRD so we don't need this v1alpha1 .

Nick suggested an alternative new API , see his comment in :
#1959 (comment)

If we will introduce a new API CRD such as Integration , then we need to put it in a v1alpha1 version.
We described this alternative API in the section "Alternatives API Considered" above.

That approach will introduce additional discussions about API changes and more general integration controller(s). I feel those need to be in follow up SEPs and this SEP focuses on metric monitoring controller first.

I will remove this v1alpha1 here. Thanks.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

just a nit on the filename: we have migrated to numbering the SEPs based on the issue that they're about. it appears we don't have an open issue that tracks this work, so that would be the first step, and then we can call this SEP12345 (if 12345 ends up being the issue number)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I see. This was requested in a JIRA by Nick and we have an epic , tasks. I will update this file name with the JIRA number.

@yxun yxun changed the title SEP for observability integration (monitoring controller) [WIP] SEP for observability integration (monitoring controller) Jul 1, 2026
yxun added 2 commits July 1, 2026 15:56
Signed-off-by: Yuanlin Xu <yuanlin.xu@redhat.com>
Signed-off-by: Yuanlin Xu <yuanlin.xu@redhat.com>
@yxun yxun changed the title [WIP] SEP for observability integration (monitoring controller) enhancements: add SEP for metrics integration Jul 1, 2026
Signed-off-by: Yuanlin Xu <yuanlin.xu@redhat.com>
@yxun yxun force-pushed the enhancements/sep3-observability branch from 4d84c44 to 062add7 Compare July 1, 2026 20:53
@yxun

yxun commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

/test integ-tests-arm64

@codecov

codecov Bot commented Jul 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.75%. Comparing base (21f9c7e) to head (062add7).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2028      +/-   ##
==========================================
+ Coverage   76.32%   76.75%   +0.42%     
==========================================
  Files          58       58              
  Lines        3181     3222      +41     
==========================================
+ Hits         2428     2473      +45     
+ Misses        612      610       -2     
+ Partials      141      139       -2     
Flag Coverage Δ
integration-tests 69.24% <ø> (-0.50%) ⬇️
unit-tests 53.16% <ø> (+0.60%) ⬆️

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

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fjglira fjglira left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, as we discussed in the yesterday's meeting, I'll use some time to take a look into the implementation. Adding a hold label to let @dgn to add any final comment

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants