Feature to opt-in/opt-out log collection #14521

visingl · 2021-05-21T22:36:05Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-05-21T22:36:08Z

Hi, @visingl Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2021-05-21T22:36:08Z

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2020-03-01-preview/deviceupdate.json compared with base:preview/2020-03-01-preview/deviceupdate.json

Rule	Message
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'enableDiagnostics' in response that was not found in the old version. New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L766:11 Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L766:11

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- deviceupdate/resource-manager/readme.md tag:package-2020-03-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- deviceupdate/resource-manager/readme.md tag:package-2020-03-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'instances' with immediate parent 'Account', must have a list by immediate parent operation. Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L683
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: common-types/resource-management/v1/types.json#L339
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: common-types/resource-management/v2/types.json#L604
⚠️ R3027 - TrackedResourceListByResourceGroup	The tracked resource, 'Instance', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L749
⚠️ R3028 - TrackedResourceListBySubscription	The tracked resource, 'Instance', must have a list by subscriptions operation. Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L749
⚠️ R4021 - DescriptionAndTitleMissing	'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L693
⚠️ R4021 - DescriptionAndTitleMissing	'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L758
⚠️ R4024 - PreviewVersionOverOneYear	The API version:2020-03-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L6
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets list of Accounts Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L460

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

deviceupdate/resource-manager/readme.md#package-2020-03-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"deviceupdate/resource-manager/readme.md",
"tag":"package-2020-03-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"deviceupdate/resource-manager/readme.md",
"tag":"package-2020-03-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"deviceupdate/resource-manager/readme.md",
"tag":"package-2020-03-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-05-21T22:36:09Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-python-track2 - track2_azure-mgmt-deviceupdate - 1.0.0b2

+	Model ErrorResponse has a new signature

❌azure-sdk-for-go - preview/deviceupdate/mgmt/2020-03-01-preview/deviceupdate - v55.0.0

+	Const `System` has been removed
+	Const `User` type has been changed from `Origin` to `CreatedByType`
+	Const `Usersystem` has been removed
+	Field `AdditionalInfo` of struct `ErrorResponse` has been removed
+	Field `Code` of struct `ErrorResponse` has been removed
+	Field `Details` of struct `ErrorResponse` has been removed
+	Field `Message` of struct `ErrorResponse` has been removed
+	Field `Target` of struct `ErrorResponse` has been removed
+	Function `ErrorDefinition.MarshalJSON` has been removed
+	Function `ErrorResponse.MarshalJSON` has been removed
+	Struct `ErrorDefinition` has been removed

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8301bf9. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/deviceupdate/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmdout	[Autorest] WARNING: HEAD 'Head' method missing 404 status code section -- this might be unintentional.
cmdout	[Autorest] WARNING: HEAD 'Head' method missing 404 status code section -- this might be unintentional.

️✔️Microsoft.Azure.Management.DeviceUpdate [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.DeviceUpdate.1.0.1-beta.1.nupkg
- Microsoft.Azure.Management.DeviceUpdate.1.0.1-beta.1.snupkg

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 8301bf9. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-deviceupdate [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model AccountUpdate has a new parameter identity
info	[Changelog]   - Model Instance has a new parameter system_data
info	[Changelog]   - Model Instance has a new parameter enable_diagnostics
info	[Changelog]   - Model Account has a new parameter system_data
info	[Changelog]   - Model Account has a new parameter identity
info	[Changelog]   - Added operation InstancesOperations.head
info	[Changelog]   - Added operation AccountsOperations.head
info	[Changelog]   - Added operation group DeviceUpdateOperationsMixin
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model ErrorResponse has a new signature

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8301bf9. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️preview/deviceupdate/mgmt/2020-03-01-preview/deviceupdate [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Const `User` type has been changed from `Origin` to `CreatedByType`
info	[Changelog] - Const `System` has been removed
info	[Changelog] - Const `Usersystem` has been removed
info	[Changelog] - Function `ErrorResponse.MarshalJSON` has been removed
info	[Changelog] - Function `ErrorDefinition.MarshalJSON` has been removed
info	[Changelog] - Struct `ErrorDefinition` has been removed
info	[Changelog] - Field `Message` of struct `ErrorResponse` has been removed
info	[Changelog] - Field `Target` of struct `ErrorResponse` has been removed
info	[Changelog] - Field `Details` of struct `ErrorResponse` has been removed
info	[Changelog] - Field `AdditionalInfo` of struct `ErrorResponse` has been removed
info	[Changelog] - Field `Code` of struct `ErrorResponse` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `SystemAssigned`
info	[Changelog] - New const `Application`
info	[Changelog] - New const `Key`
info	[Changelog] - New const `ManagedIdentity`
info	[Changelog] - New const `None`
info	[Changelog] - New const `AlreadyExists`
info	[Changelog] - New const `OriginUser`
info	[Changelog] - New const `OriginSystem`
info	[Changelog] - New const `OriginUsersystem`
info	[Changelog] - New const `Invalid`
info	[Changelog] - New function `AccountsClient.HeadSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `PossibleCheckNameAvailabilityReasonValues() []CheckNameAvailabilityReason`
info	[Changelog] - New function `AccountsClient.HeadResponder(*http.Response) (autorest.Response, error)`
info	[Changelog] - New function `PossibleResourceIdentityTypeValues() []ResourceIdentityType`
info	[Changelog] - New function `BaseClient.CheckNameAvailabilityResponder(*http.Response) (CheckNameAvailabilityResponse, error)`
info	[Changelog] - New function `AccountsClient.Head(context.Context, string, string) (autorest.Response, error)`
info	[Changelog] - New function `Identity.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `InstancesClient.HeadSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `AccountsClient.HeadPreparer(context.Context, string, string) (*http.Request, error)`
info	[Changelog] - New function `InstancesClient.Head(context.Context, string, string, string) (autorest.Response, error)`
info	[Changelog] - New function `ErrorDetail.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `BaseClient.CheckNameAvailability(context.Context, CheckNameAvailabilityRequest) (CheckNameAvailabilityResponse, error)`
info	[Changelog] - New function `InstancesClient.HeadPreparer(context.Context, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `BaseClient.CheckNameAvailabilitySender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `BaseClient.CheckNameAvailabilityPreparer(context.Context, CheckNameAvailabilityRequest) (*http.Request, error)`
info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
info	[Changelog] - New function `InstancesClient.HeadResponder(*http.Response) (autorest.Response, error)`
info	[Changelog] - New struct `CheckNameAvailabilityRequest`
info	[Changelog] - New struct `CheckNameAvailabilityResponse`
info	[Changelog] - New struct `ErrorDetail`
info	[Changelog] - New struct `Identity`
info	[Changelog] - New struct `SystemData`
info	[Changelog] - New field `SystemData` in struct `Account`
info	[Changelog] - New field `Identity` in struct `Account`
info	[Changelog] - New field `Identity` in struct `AccountUpdate`
info	[Changelog] - New field `EnableDiagnostics` in struct `InstanceProperties`
info	[Changelog] - New field `SystemData` in struct `Instance`
info	[Changelog] - New field `Error` in struct `ErrorResponse`
info	[Changelog]
info	[Changelog] Total 8 breaking change(s), 42 additive change(s).
info	[Changelog]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-05-21T22:36:09Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

raych1 · 2021-05-24T01:06:31Z

@visingl , can you go through the first comment of this PR and check on proper items? I assume this service isn't GAed, right? Is public repo master branch used in rpaas production or it uses private repo RpSaasMaster branch spec?

openapi-workflow-bot · 2021-05-24T02:30:38Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

raych1 · 2021-05-25T03:17:10Z

@ArcturusZhang @msyyc , can you check if there's any potential breaking change for GO/Python SDKs?

msyyc · 2021-05-27T02:06:26Z

For python, the breaking change is ok.

abatishchev · 2021-05-27T02:12:37Z

/azp run

azure-pipelines · 2021-05-27T02:12:47Z

Azure Pipelines successfully started running 1 pipeline(s).

ArcturusZhang · 2021-05-27T04:50:31Z

The brekaing changes are accumulated from previous PRs.

raych1 · 2021-05-27T09:34:07Z

Breaking change policy is out of scope because this service is not GAed.

zhenglaizhang · 2021-05-29T11:48:34Z

/azp run

azure-pipelines · 2021-05-29T11:48:44Z

Azure Pipelines successfully started running 1 pipeline(s).

Feature to opt-in/opt-out log collection

fb8f3ac

visingl marked this pull request as ready for review May 23, 2021 00:10

openapi-assignment-bot bot assigned raych1 May 23, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label May 24, 2021

openapi-pipeline-app bot added CI-BreakingChange-Go CI-BreakingChange-Python-Track2 labels May 24, 2021

raych1 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 27, 2021

raych1 approved these changes May 27, 2021

View reviewed changes

raych1 merged commit 8301bf9 into master May 31, 2021

heaths mentioned this pull request Jun 16, 2021

Initial 2021-05-01-preview version #14855

Merged

mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021

Feature to opt-in/opt-out log collection (Azure#14521)

4557c26

visingl deleted the user/visingl/diagnostics-1 branch March 17, 2022 18:46

visingl restored the user/visingl/diagnostics-1 branch March 17, 2022 18:46

visingl deleted the user/visingl/diagnostics-1 branch March 17, 2022 18:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature to opt-in/opt-out log collection #14521

Feature to opt-in/opt-out log collection #14521

visingl commented May 21, 2021 •

edited by abatishchev

Loading

openapi-workflow-bot bot commented May 21, 2021

openapi-pipeline-app bot commented May 21, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 21, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented May 21, 2021

raych1 commented May 24, 2021

openapi-workflow-bot bot commented May 24, 2021

raych1 commented May 25, 2021

msyyc commented May 27, 2021

abatishchev commented May 27, 2021

azure-pipelines bot commented May 27, 2021

ArcturusZhang commented May 27, 2021

raych1 commented May 27, 2021

zhenglaizhang commented May 29, 2021

azure-pipelines bot commented May 29, 2021

Feature to opt-in/opt-out log collection #14521

Feature to opt-in/opt-out log collection #14521

Conversation

visingl commented May 21, 2021 • edited by abatishchev Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 21, 2021

openapi-pipeline-app bot commented May 21, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 21, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented May 21, 2021

raych1 commented May 24, 2021

openapi-workflow-bot bot commented May 24, 2021

raych1 commented May 25, 2021

msyyc commented May 27, 2021

abatishchev commented May 27, 2021

azure-pipelines bot commented May 27, 2021

ArcturusZhang commented May 27, 2021

raych1 commented May 27, 2021

zhenglaizhang commented May 29, 2021

azure-pipelines bot commented May 29, 2021

visingl commented May 21, 2021 •

edited by abatishchev

Loading

openapi-pipeline-app bot commented May 21, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 21, 2021 •

edited

Loading