Skip to content

HawkFlow.ai Concepts

Process

Process is the main required parameter when sending data to any HawkFlow.ai API endpoint. Process name is the main grouping parameter for anything you send through to HawkFlow.ai. This could be an App (web | mobile | command line) name, the name of a Machine Learning model, or the name of an ETL process. It should represent something that you would like to group everything under that name by.

Meta

Meta is the compliment parameter to process and is not required when sending data to HawkFlow.ai API endpoints. However it is very useful when you would like to filter your data in the UI. You should put in the meta parameter, everything that you would like to filter the process by. This could be any parameters you usually send to the app when it is running and that would be interesting to view monitoring about. It could be such things as a country or region, a client or account id, or any other meta data about the process. You will be able to filter the process by the meta parameter in the HawkFlow.ai App UI.

Over

Over represents the amount of time a process is running over time when compared to the average maximum time it takes to run. HawkFlow will calculate expected minimum and maximum run times for all process / meta combinations. A status of 'running over time' will be reported if the maximum expected time is exceeded.

Example of process time chart displaying over time

Example of process time chart displaying over time

Example of process time chart displaying over time

You can view the exact details in the raw data page

Under

Under represents the amount of time a process is running under time when compared to the average minimum time it takes to run. HawkFlow will calculate expected minimum and maximum run times for all process / meta combinations. A status of 'running under time' will be reported if the maximum expected time is exceeded.

Example of process time chart displaying under time

Example of process time chart displaying under time

Example of process time chart displaying under time

You can view the exact details in the raw data page

Failed

A failed process will be reported if the process / meta combination is started, but then no end is received before the same process / meta is started. When this happens, the process / meta combination is deemed to have failed its previous run. You can consider it as a process / meta combination must start and end to be successful. So, if a process / meta combination starts but does not end, then it will be considered a failed attempt to run that process.

Example of process time chart displaying a failed process

Example of process time chart displaying a failed process

Example of process time chart displaying a failed process details

You can view the exact details in the raw data page

Rerun

A rerun is partnered with failed process / meta combinations. If a process / meta combination fails, then the next start it receives will be considered a rerun. You can consider it as a process / meta combination must start and end to be successful. So, if a process / meta combination starts but does not end, then all following process / meta combination of that type will be considered reruns until one ends successfully.

Missing

A missing process / meta combination is one that does not run when it is expected to run. HawkFLow.ai will detect the schedule for all process / meta combinations. If the process / meta combination then does not run on the expected schedule, it will be reported as missing.

Process / meta combinations can be excluded from this type of reporting in the App UI. This can be done from the Schedule page, or in the Exclusions part of the settings in the App UI.

Example reporting of a missing process

example reporting of a missing process

HawkFlow.ai will learn the characteristics of a process run time and then alert you if the process runtime is trending upwards over time

Example reporting of a process trending up

example reporting of a missing process

HawkFlow.ai will learn the characteristics of a process run time and then alert you if the process runtime is trending downwards over time.

Example reporting of process trending down

example reporting of a missing process

Running

Running means that this Process / meta combination is running right now. The UI will show you running process and the details of them, such as how long they have been running, when they were expected to start, and whether they are running over or under their expected runtime.

Metrics

Metrics are any data with a name and value that is sent to the metrics end point. Metrics can be anything from the amount of rows in a dataset, to accuracy metrics from a machine learning model.

All you need to do is send us these values, and we will create a unique time series dataset for each one. From there you will be able to view charts, look at the raw data, track changes, and HawkFlow.ai will automatically let you know of any anomalies or trends in your data.

Example of metrics in the App UI

Example of metrics in the App UIs

Exceptions

Exceptions represent data that is sent to the HawkFlow.ai API exceptions end point. They are typically expected to be standard programming exceptions. You can vew exception details in the exception page of the HawkFlow.ai App.

Example of an exception in the App UI

Example of an exception in the App UI