From 7a7258ce2be92eff5a9f873918c09a97bc39a2f4 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Sat, 16 Mar 2024 17:57:38 -0700 Subject: [PATCH] [status] Remove deprecated functions `ReportComponentStatus` and `ReportComponentOkIfStarting` --- .../remove_deprecated_status_functions.yaml | 25 +++++++++++++++++++ service/internal/status/status.go | 19 -------------- 2 files changed, 25 insertions(+), 19 deletions(-) create mode 100644 .chloggen/remove_deprecated_status_functions.yaml diff --git a/.chloggen/remove_deprecated_status_functions.yaml b/.chloggen/remove_deprecated_status_functions.yaml new file mode 100644 index 00000000000..226974d78f9 --- /dev/null +++ b/.chloggen/remove_deprecated_status_functions.yaml @@ -0,0 +1,25 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) +component: status + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Remove the deprecated `ReportComponentStatus` and `ReportComponentOkIfStarting` functions. + +# One or more tracking issues or pull requests related to the change +issues: [9148] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [api] diff --git a/service/internal/status/status.go b/service/internal/status/status.go index 21790b1061f..e1d524906e5 100644 --- a/service/internal/status/status.go +++ b/service/internal/status/status.go @@ -121,17 +121,6 @@ func (r *Reporter) Ready() { r.ready = true } -// ReportComponentStatus reports status for the given InstanceID -// Deprecated: [v0.92.0] This function will be removed in a future release. -// Use ReportStatus instead. -func (r *Reporter) ReportComponentStatus( - id *component.InstanceID, - ev *component.StatusEvent, -) error { - r.ReportStatus(id, ev) - return nil -} - // ReportStatus reports status for the given InstanceID func (r *Reporter) ReportStatus( id *component.InstanceID, @@ -148,14 +137,6 @@ func (r *Reporter) ReportStatus( } } -// ReportComponentOkIfStarting reports StatusOK if the component's current status is Starting -// Deprecated: [v0.92.0] This function will be removed in a future release. -// Use ReportOKIfStarting instead. -func (r *Reporter) ReportComponentOKIfStarting(id *component.InstanceID) error { - r.ReportOKIfStarting(id) - return nil -} - func (r *Reporter) ReportOKIfStarting(id *component.InstanceID) { r.mu.Lock() defer r.mu.Unlock()