Skip to content

Commit

Permalink
[receiver/activedirectoryds] Fix panic on Shutdown without correspond…
Browse files Browse the repository at this point in the history
…ing Start call (open-telemetry#29505)

**Description:**
The `activedirectorydsreceiver` is panicking when Shutdown is called
without a previous call to Start. This can happen when some component
fails to be created or started.

**Link to tracking Issue:**
Required for open-telemetry#28679

**Testing:**
Ran test locally and `Run Windows` on my fork.

**Documentation:**
.chloggen for bug fix.
  • Loading branch information
pjanotti committed Nov 27, 2023
1 parent 506813e commit de3b9c0
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: 'bug_fix'

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: 'receiver/activedirectoryds'

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Fix shutdown of `activedirectorydsreceiver` when shutdown was called right after creation, without a corresponding start call.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [29505]

# (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:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# 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: []
2 changes: 1 addition & 1 deletion receiver/activedirectorydsreceiver/counters.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func (w *watchers) Scrape(name string) (float64, error) {
}

func (w *watchers) Close() error {
if w.closed {
if w == nil || w.closed {
return nil
}

Expand Down
4 changes: 4 additions & 0 deletions receiver/activedirectorydsreceiver/factory_windows_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,9 @@ func TestCreateMetricsReceiver(t *testing.T) {

require.NoError(t, err)
require.NotNil(t, recv)

// The receiver must be able to shutdown cleanly without a Start call.
err = recv.Shutdown(context.Background())
require.NoError(t, err)
})
}

0 comments on commit de3b9c0

Please sign in to comment.