-
Notifications
You must be signed in to change notification settings - Fork 11
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
Exporter refresh #20
Merged
Merged
Exporter refresh #20
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
fcf722e
to
26751ea
Compare
0b3caeb
to
018b3ac
Compare
018b3ac
to
0fc800e
Compare
@jack-cloud-platform I think this is ready for testing now. The only outstanding question is how we catch calls that are supposed to hit the legacy maintenance window api:
|
Given that the new StatusCake SDK implementations are well documented and follow a set standard, we can assume that the pagination requirements do not differ between endpoint calls. This means that we can refactor the code so that pagination is handled by a single private method. The method will take a function definition and a set of args, perform the required pagination and return a response to the caller.
884e28d
to
83012ab
Compare
83012ab
to
7f34d8d
Compare
ecda812
to
75a96bf
Compare
CloudPlatformer
approved these changes
Dec 2, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great refresh @chelnak!
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.
Prior to this change many elements of the exporter were outdated, along with the development methods being used.
The new app uses poetry for dependency management, includes type hints and is now running on a modern python version. In addition the app now users typer instead of ConfigArgParse to provide a consistent cli ux.
From the next release, the exporter will also be published as a wheel so that it can be installed with pip, poetry or another tool of choice.
This change also includes a refresh to the apps logic.
Moving forward, we will be using the python SDK provided by status cake.
The SDK has been abstracted away in to a new internal class so that we have control over the interface exposed to the collector.
Namely, we can gracefully handle things like forbidden access to paid features or the issues surrounding the maintenance window api without polluting the logic of the collector.
While this change will aim to be as non-destructive as possible it will be a breaking release given that we cannot guarantee that everything will work as it did before.
Outstanding actions:
To test this PR you will need to install poetry and run
poetry install
to download dependencies.To run the app use
poetry run status-cake-exporter