Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azurerm_monitor_diagnostic_setting - wait resource to become ready in creation #25697

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

teowa
Copy link
Contributor

@teowa teowa commented Apr 22, 2024

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Wait until the resource is ready in creation. The wait logic is to query the status at a minimum interval of 5 seconds until 3 consecutive response return that the resource exists. And if the resource doesn't exist the interval increases exponentially according to

// Wait between refreshes using exponential backoff, except when
// waiting for the target state to reoccur.
if targetOccurence == 0 {
wait *= 2
}

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

Changes to existing Resource / Data Source

  • I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
  • I have written new tests for my resource or datasource changes & updated any relevent documentation.
  • I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
  • (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

  • My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Test result is OK. The failed test is because of subscription issue The limit of 5 diagnostic settings was reached
image

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

  • azurerm_monitor_diagnostic_setting - wait resource to become ready in creation

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Related Issue(s)

Fixes #25676
Fixes #25667

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

@rcskosir
Copy link
Contributor

@teowa Thank you for using our new PR template, can you please update to include a description for this PR under the Description header? This helps with traceability for our users.

@JoDexsph
Copy link

Thanks for your contribution!

Copy link
Member

@jackofallops jackofallops left a comment

Choose a reason for hiding this comment

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

Thanks @teowa. One comment to address, which will also need applying to the delete function for the same bug.

Can you also open an issue on the API Specs for this resource as the need for this suggests that the API call should in fact be an LRO with a poller if the resource is only completed async? Please include the issue link as a comment so we can track it and update if/when it is addressed.

Thanks!

Refresh: monitorDiagnosticSettingRefreshFunc(ctx, client, id),
MinTimeout: 5 * time.Second,
ContinuousTargetOccurence: 3,
Timeout: d.Timeout(pluginsdk.TimeoutCreate),
Copy link
Member

Choose a reason for hiding this comment

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

Can we use the calculated deadline from the context here otherwise that will potentially expire before this WaitForStateContext is complete. e.g.

	deadline, ok := ctx.Deadline()
	if !ok {
		return fmt.Errorf("could not retrieve context deadline for %s", id.ID())
	}

...

	Timeout: time.Until(deadline)

Can you also update the other instance(s) of this bug in this resource while we're here?

@katbyte
Copy link
Collaborator

katbyte commented May 6, 2024

@teowa - this is gtg i think once the rest api specs issue is opened anc linked to in the code via a comment

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