shadowman / omni-metric Goto Github PK

from the file events.py we have the following:

class EventType(Enum):
    SERVICE_RESTORED = "service_restored"
    SERVICE_FAILING = "service_failing"
    ERROR = "error"
    NULL = "null"
    DEPLOY_FAILED = "deploy_failed"
    BUILD_FAILED = "build_failed"
    TEST_FAILED = "test_failed"
    TEST_SUCCESS = "test_success"
    DEPLOY_SUCCESS = "deploy_success"
    BUILD_SUCCESS = "build_success"

ERROR or NULL are descriptive, those are meant to be fired when an error occurs in the application, opening this issue for discussion.

Implement a basic DF metric that can take input from a file. Use the CLI behaviour.

CSV format can be 'datetime', 'step_name', 'status'

Currently we have a limitation using the github workflow api to process the metrics.

Private repositories are not working

During the live we should replace the cli lib that we are currently using. We will move to https://typer.tiangolo.com/.

Implement a basic lead time metric that can take input from a file. Use the CLI behaviour.

CSV format can be 'datetime', 'step_name', 'status'

For the discussion that we had, we will start with a single source (github actions - https://miro.com/app/board/uXjVOdNGlQs=/). For that a few hard decisions were made:

• We should pull data from time to time instead of push in the pipeline.
• We also should have some sort of hexagonal architecture in mind to implement the source, as we will start with github actions and integrate more of those later on.

Acceptance criteria

pull data from the github action and write it down in to the CSV

It seems typer is having some issue trying to follow this behavior, there is some discussion going on here: tiangolo/typer#328

I am opening this issue to keep track of this one.

Implement a basic CFR metric that can take input from a file. Use the CLI behaviour.

CSV format can be 'datetime', 'step_name', 'status'

The goal is to have the documentation on how to:

1. set up the project for development
2. Important concepts of the project such as coding style, architectural style

Implement a basic MTTR metric that can take input from a file. Use the CLI behaviour.

CSV format can be 'datetime', 'step_name', 'status'

Add basic CLI functionality to run the analytics from the terminal