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

Improve flow and HA-flow history response structure and API #5339

Open
dmitrii-beliakov opened this issue Aug 17, 2023 · 1 comment
Open

Comments

@dmitrii-beliakov
Copy link
Collaborator

This feature is intended to improve flow and HA-flow history responses, so that the information is more clear, structured, easier to understand. This feature will introduce new API and will not break any existing API.

  1. Response payload structure
    A payload of the history response will have the following structure:
[collection of history events]
   |- History event
        | - history event body fields
        | - [collection of actions]
              | - action body fields
              | - dump
                   | - dump fields

Each action could have one dump. When it is required to have more dumps (such as dump before and dump after), the dumps are saved in separate actions. This feature will resolve a problem of having two dumps inside one event when dumps are saved for primary paths and then for the protected paths.

  1. Response payload fields
    Name timestamp fields to clearly distinguish event's timestamp from history record timestamp. Format timestamps into human-readable format (ISO 8601).
  2. Allow request parameters for filtering to accept timestamps in ISO 8601 format as well as epoch time in seconds and milliseconds. (change filter parameter type from long to string)
  3. Rename task ID to correlation ID.
@dmitrii-beliakov
Copy link
Collaborator Author

This issue will help to resolve other related issues. For example, mentioned in comments in #5497 issue related to saving paths in the IN_PROGRESS state. Once the dumps are linked to the actions is will be more clear why they are in this state, as well as it will be easier to investigate and fix issues, because it will be easier to localize them.

https://github.com/search?q=repo%3Atelstra%2Fopen-kilda%20BaseFlowResourceAllocationAction&type=code

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

No branches or pull requests

2 participants