Add gateway APM support #5652
Merged
Add gateway APM support #5652
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
spring |
zhoxing-ms
reviewed
Jan 5, 2023
src/spring/azext_spring/_params.py
Outdated
Comment on lines
721
to
722
| c.argument('apm_types', nargs='*', | ||
| help="Space-separated list of APM integrated with Gateway, Allowed values: [\"ApplicationInsights\", \"AppDynamics\", \"Dynatrace\", \"NewRelic\", \"ElasticAPM\"].") |
There was a problem hiding this comment.
Could we define the allowed values as enumeration values and then use the get_enum_type? In addition, can we get these values from the Python SDK?
zhoxing-ms
reviewed
Jan 5, 2023
| def _validate_gateway_apm_types(namespace): | ||
| if namespace.apm_types is None: | ||
| return | ||
| allowedApmTypes = ["ApplicationInsights", "AppDynamics", "Dynatrace", "NewRelic", "ElasticAPM"] |
There was a problem hiding this comment.
It is recommended to define the allowed value as an enumeration, and then reuse it with _params.py
zhoxing-ms
reviewed
Jan 5, 2023
| allowedApmTypes = ["ApplicationInsights", "AppDynamics", "Dynatrace", "NewRelic", "ElasticAPM"] | ||
| for type in namespace.apm_types: | ||
| if (type not in allowedApmTypes): | ||
| raise InvalidArgumentValueError("Allowed APM types are \"ApplicationInsights\", \"AppDynamics\", \"Dynatrace\", \"NewRelic\", \"ElasticAPM\".") |
zhoxing-ms
reviewed
Jan 6, 2023
src/spring/azext_spring/_params.py
Outdated
Comment on lines
721
to
722
| c.argument('apm_types', nargs='*', | ||
| help="Space-separated list of APM integrated with Gateway.") |
There was a problem hiding this comment.
I believe the allowedApmTypes enumeration can be reused here
zhoxing-ms
reviewed
Jan 6, 2023
Comment on lines
226
to
233
| allowedApmTypes = [v20221101_preview_AppPlatformEnums.GatewayApmType.APPLICATION_INSIGHTS, | ||
| v20221101_preview_AppPlatformEnums.GatewayApmType.APP_DYNAMICS, | ||
| v20221101_preview_AppPlatformEnums.GatewayApmType.DYNATRACE, | ||
| v20221101_preview_AppPlatformEnums.GatewayApmType.NEW_RELIC, | ||
| v20221101_preview_AppPlatformEnums.GatewayApmType.ELASTIC_APM] | ||
| for type in namespace.apm_types: | ||
| if (type not in allowedApmTypes): | ||
| raise InvalidArgumentValueError("Allowed APM types are " + ','.join(allowedApmTypes)) |
There was a problem hiding this comment.
How about using the v20221101_preview_AppPlatformEnums.GatewayApmType enumeration from Python SDK directly?
zhoxing-ms
reviewed
Jan 6, 2023
Comment on lines
442
to
449
| class GatewayApmType(str, Enum, metaclass=CaseInsensitiveEnumMeta): | ||
| """Spring Cloud Gateway APM Type.""" | ||
|
|
||
| APPLICATION_INSIGHTS = "ApplicationInsights" | ||
| APP_DYNAMICS = "AppDynamics" | ||
| DYNATRACE = "Dynatrace" | ||
| NEW_RELIC = "NewRelic" | ||
| ELASTIC_APM = "ElasticAPM" |
There was a problem hiding this comment.
May I ask whether this enumeration is automatically generated by the Python SDK or manually added by you?
zhoxing-ms
reviewed
Jan 6, 2023
src/spring/azext_spring/_params.py
Outdated
Comment on lines
42
to
45
| from .vendored_sdks.appplatform.v2022_01_01_preview.models._app_platform_management_client_enums import SupportedRuntimeValue, TestKeyType | ||
| from .vendored_sdks.appplatform.v2022_09_01_preview.models._app_platform_management_client_enums import BackendProtocol, SessionAffinity | ||
| from .vendored_sdks.appplatform.v2022_11_01_preview.models \ | ||
| import _app_platform_management_client_enums as v20221101_preview_AppPlatformEnums |
There was a problem hiding this comment.
Could you make the way of importing enumeration consistent?
zhoxing-ms
reviewed
Jan 6, 2023
Comment on lines
227
to
228
| if (type not in list(v20221101_preview_AppPlatformEnums.ApmType)): | ||
| raise InvalidArgumentValueError("Allowed APM types are: " + ', '.join(list(v20221101_preview_AppPlatformEnums.ApmType))) |
zhoxing-ms
approved these changes
Jan 6, 2023
|
[Release] Update index.json for extension [ spring ] : https://dev.azure.com/azclitools/internal/_build/results?buildId=24519&view=results |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add new arguments
--apm-types,--propertiesand--secretsforaz spring gateway updateGeneral Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally?For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.The precondition is to put your code inside this repository and upgrade the version in the pull request but do not modify
src/index.json.