[component] Move component status reporting public API to new componentstatus module #10730

TylerHelmuth · 2024-07-26T19:13:51Z

Description

Duplicates component status reporting features from component into a separate module, componentstatus. In a future PR, when component.TelemetrySettings.ReportStatus is removed, I'll update Core to depend on componentstatus.

This work isolates component status public API from component and extensions, which will allow us to move forward with their 1.0 work while component status reporting matures.

Link to tracking issue

Related to #10725

codecov · 2024-07-26T19:38:16Z

Codecov Report

Attention: Patch coverage is 97.67442% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.12%. Comparing base (524a901) to head (e99f56d).

Files	Patch %	Lines
component/componentstatus/status.go	97.67%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10730      +/-   ##
==========================================
+ Coverage   92.11%   92.12%   +0.01%     
==========================================
  Files         403      404       +1     
  Lines       18806    18849      +43     
==========================================
+ Hits        17323    17365      +42     
- Misses       1123     1124       +1     
  Partials      360      360

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

atoulme

LGTM, just a bit dubitative, because this adds a new module to stabilize.

TylerHelmuth · 2024-07-27T17:02:51Z

@atoulme the current plan is to not stabilize consumerstatus as part of 1.0 work. Component status reporting currently has not direct user configuration and no public api in service. Once ReportStatus and ComponentStatus Watcher are removed from component and extension respectively there won't be any public status reporting APIs in the modules we marked in scope.

atoulme · 2024-07-27T18:01:18Z

I see, that’s an elegant way to narrow down what we need to stabilize. I appreciate the rationale. Looks good to me.

mx-psi

LGTM, but we can wait until we have solved the main questions on your draft PR

component/componentstatus/status.go

component/componentstatus/instance.go

component/componentstatus/status_test.go

mwear · 2024-07-29T23:09:14Z

@atoulme the current plan is to not stabilize consumerstatus as part of 1.0 work. Component status reporting currently has not direct user configuration and no public api in service. Once ReportStatus and ComponentStatus Watcher are removed from component and extension respectively there won't be any public status reporting APIs in the modules we marked in scope.

As mentioned here, I have serious reservations about this plan.

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

mx-psi · 2024-07-30T09:35:16Z

I think we should move forward with this. The healtcheck extension is not in our GA roadmap, and in any case doing this unblocks progress in many other modules needed for 1.0.

bogdandrutu · 2024-07-30T18:18:18Z

component/componentstatus/status.go

+}
+
+// Timestamp returns the timestamp associated with the Event
+func (ev *Event) Timestamp() time.Time {


Timestamp seem to be use-less, because it is always "now", which means consumers (watchers) can also read if they need it.

This is important for the healthcheck extension, which also needs to synthesize events. When synthesizing events the timestamp needs to be settable. We used to do this in core, but have removed it, at least temporarily. I was proposing we add an option to set the timestamp in a followup: #10730 (comment).

What about, if this is needed for that extension, we can have StatusWithTime struct {Status, Time} in the healthcheck and not here. No point in having it here.

Also, until we discuss the next PR, I would rather remove this for the moment.

I prefer to keep this PR a 1-to-1 move of stuff related to component status reporting into componentstatus. In my opinion we can have API discussions about componentstatus in future issues/PRs. I can update the godocs to state that everything in componentstatus is experimental and currently exempt from our deprecation process if you'd like.

I prefer to keep this PR a 1-to-1 move of stuff related to component status reporting into componentstatus. In my opinion we can have API discussions about componentstatus in future issues/PRs. I can update the godocs to state that everything in componentstatus is experimental and currently exempt from our deprecation process if you'd like.

Then update the title to "move code" instead of adding a new module which to me means we can do a better job.

I think a timestamp will be useful for other status watchers and worth considering for the generated status event. Otherwise, if there are multiple watchers that care about the timestamp, each one will have to wrap the event in a custom struct and generate timestamps independently.

I think a timestamp will be useful for other status watchers and worth considering for the generated status event. Otherwise, if there are multiple watchers that care about the timestamp, each one will have to wrap the event in a custom struct and generate timestamps independently.

When in doubt leave it out. I am not convinced yet, and until we have 2-3 use-cases we should not add it, since adding later is backwards compatible, but currently we pay the cost of reading the time as well as the maintenance cost.

Followup issue created: #10763

I will still suggest the timestamp has value. I wrote the following on the issue:

I believe that we should keep the timestamp as the observed time is not the same time as the observation. Since status watchers are dispatched in sequence, any status watcher that does a non-trivial amount of work, or something that could block (like writing to an event to a channel) could delay the observed time for subsequent watchers. This would be especially problematic if the delay was variable between invocations. Currently the timestamp is used by the health check extension for time calculations.

bogdandrutu · 2024-07-30T18:20:33Z

component/componentstatus/status.go

+// Watcher is an extra interface for Extension hosted by the OpenTelemetry
+// Collector that is to be implemented by extensions interested in changes to component
+// status.
+type Watcher interface {


I would move this + the InstanceId to the "extension/statuswatcher` or something like that to be consistent with storage and other type of extensions.

I think you're probably correct, but I'd prefer to encompass all public component status reporting features behind componentstatus for now while it is experimental and subject to lots of breaking API discussions. Once we feel better about its API we could move it into extension/storage as a final location. Likely other aspects of componentstatus will move around in the future as well.

Not suggesting to extension/storage but to extension/statuswatcher :)

I am confused about why we do this then. Is this to just remove unstable code (that is ok)? But still you should at least document all these things as todos (file issues) and then we can do it in a separate PR.

Removing unstable code from component and extension is the goal. Issue created: #10764

…-module

mx-psi · 2024-07-31T10:52:21Z

AIUI all remaining issues are about the content of the module and not about the split itself so IMO we can go ahead with this. @bogdandrutu @mwear could you have a final look before I merge?

mwear

LGTM

Add componentstatus module

356a4a5

TylerHelmuth requested review from a team and djaglowski July 26, 2024 19:13

TylerHelmuth mentioned this pull request Jul 26, 2024

[component] Move component status features to its own module #10725

Closed

TylerHelmuth added 2 commits July 26, 2024 13:15

changelog

9654aa1

Update name

4132d05

TylerHelmuth requested review from mwear and mx-psi July 26, 2024 19:18

make crosslink

1c35eb7

atoulme approved these changes Jul 27, 2024

View reviewed changes

mx-psi approved these changes Jul 29, 2024

View reviewed changes

TylerHelmuth added 2 commits July 29, 2024 16:22

Merge branch 'main' into componentstatus-new-module

e40d606

Update componentstatus deps

270752d

mwear reviewed Jul 29, 2024

View reviewed changes

TylerHelmuth and others added 3 commits July 30, 2024 02:36

Update component/componentstatus/status.go

5a17c56

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

Update component/componentstatus/status_test.go

a5366a6

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

Update component/componentstatus/status_test.go

e0c4f98

Co-authored-by: Matthew Wear <matthew.wear@gmail.com>

Fix test

fb98b95

bogdandrutu reviewed Jul 30, 2024

View reviewed changes

TylerHelmuth changed the title ~~[component] Add componentstatus module~~ [component] Move component status reporting public API to new componentstatus module Jul 31, 2024

This was referenced Jul 31, 2024

[componentstatus] Consider removing timestamp from Event #10763

Open

[componentstatus] Consider moving Watcher interface and InstanceID struct to a package in extension #10764

Open

TylerHelmuth added 3 commits July 30, 2024 18:25

Update with TODOs and godoc warning

6251a9f

Merge remote-tracking branch 'upstream/main' into componentstatus-new…

b94469a

…-module

run make gotidy

e99f56d

mx-psi requested review from bogdandrutu and mwear July 31, 2024 09:35

mwear approved these changes Jul 31, 2024

View reviewed changes

bogdandrutu approved these changes Jul 31, 2024

View reviewed changes

bogdandrutu merged commit 6d32c09 into open-telemetry:main Jul 31, 2024
50 checks passed

github-actions bot added this to the next release milestone Jul 31, 2024

mwear mentioned this pull request Jul 31, 2024

[component] Make InstanceID immutable #10495

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[component] Move component status reporting public API to new componentstatus module #10730

[component] Move component status reporting public API to new componentstatus module #10730

TylerHelmuth commented Jul 26, 2024 •

edited

Loading

codecov bot commented Jul 26, 2024 •

edited

Loading

atoulme left a comment

TylerHelmuth commented Jul 27, 2024

atoulme commented Jul 27, 2024

mx-psi left a comment

mwear commented Jul 29, 2024

mx-psi commented Jul 30, 2024

bogdandrutu Jul 30, 2024

mwear Jul 30, 2024

bogdandrutu Jul 30, 2024

bogdandrutu Jul 30, 2024

TylerHelmuth Jul 30, 2024

bogdandrutu Jul 30, 2024

mwear Jul 30, 2024

bogdandrutu Jul 30, 2024

TylerHelmuth Jul 31, 2024

mwear Jul 31, 2024

bogdandrutu Jul 30, 2024

TylerHelmuth Jul 30, 2024

bogdandrutu Jul 30, 2024

bogdandrutu Jul 30, 2024

TylerHelmuth Jul 31, 2024

mx-psi commented Jul 31, 2024

mwear left a comment

[component] Move component status reporting public API to new componentstatus module #10730

[component] Move component status reporting public API to new componentstatus module #10730

Conversation

TylerHelmuth commented Jul 26, 2024 • edited Loading

Description

Link to tracking issue

codecov bot commented Jul 26, 2024 • edited Loading

Codecov Report

atoulme left a comment

Choose a reason for hiding this comment

TylerHelmuth commented Jul 27, 2024

atoulme commented Jul 27, 2024

mx-psi left a comment

Choose a reason for hiding this comment

mwear commented Jul 29, 2024

mx-psi commented Jul 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mx-psi commented Jul 31, 2024

mwear left a comment

Choose a reason for hiding this comment

TylerHelmuth commented Jul 26, 2024 •

edited

Loading

codecov bot commented Jul 26, 2024 •

edited

Loading