Skip to content

Commit

Permalink
[status] Remove deprecated functions ReportComponentStatus and `Rep…
Browse files Browse the repository at this point in the history
…ortComponentOkIfStarting`
  • Loading branch information
atoulme committed Mar 17, 2024
1 parent 3b5aee0 commit 7a7258c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 19 deletions.
25 changes: 25 additions & 0 deletions .chloggen/remove_deprecated_status_functions.yaml
Original file line number Diff line number Diff line change
@@ -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]
19 changes: 0 additions & 19 deletions service/internal/status/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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()
Expand Down

0 comments on commit 7a7258c

Please sign in to comment.