examples/notebooks/tutorials/suspicious_user_activity.ipynb
<a href="https://colab.research.google.com/github/pathwaycom/pathway/blob/main/examples/notebooks/tutorials/suspicious_user_activity.ipynb" target="_parent"></a>
In the cell below, we install Pathway into a Python 3.10+ Linux runtime.
If you are running in Google Colab, please run the colab notebook (Ctrl+F9), disregarding the 'not authored by Google' warning.
The installation and loading time is less than 1 minute.
%%capture --no-display
!pip install --prefer-binary pathway
import logging
logging.basicConfig(level=logging.CRITICAL)
In this tutorial you will learn how to perform a tumbling window operation to detect suspicious activity.
Your task is to detect suspicious user login attempts during some period of time. You have a record of login data. Your goal is to detect suspicious users who have logged in more than 5 times in a single minute.
To do this, you will be using the windowby syntax with a pw.temporal.tumbling() object. Let's jump in!
Your input data table has the following columns:
username,successful,time of a login attempt,ip_address of a login.Let's start by ingesting the data:
First ingest the data.
# Uncomment to download the required files.
# %%capture --no-display
# !wget https://public-pathway-releases.s3.eu-central-1.amazonaws.com/data/suspicious_users_tutorial_logins.csv -O logins.csv
import pathway as pw
# To use advanced features with Pathway Scale, get your free license key from
# https://pathway.com/features and paste it below.
# To use Pathway Community, comment out the line below.
pw.set_license_key("demo-license-key-with-telemetry")
class InputSchema(pw.Schema):
username: str
successful: str
time: int
ip_address: str
logins = pw.io.csv.read(
"logins.csv",
schema=InputSchema,
mode="static",
)
The CSV data has the string values "True" and "False" in the successful column.
Let's convert this to a Boolean column:
logins = logins.with_columns(successful=(pw.this.successful == "True"))
Then, let's filter attempts and keep only the unsuccessful ones.
failed = logins.filter(~pw.this.successful)
Now, perform a tumbling window operation with a duration of 60 (i.e. 1 minute).
Use the instance keyword to separate rows by the ip_address value.
result = failed.windowby(
failed.time, window=pw.temporal.tumbling(duration=60), instance=pw.this.ip_address
).reduce(
ip_address=pw.this._pw_instance,
count=pw.reducers.count(),
)
...and finally, let's keep only the IP addresses where the number of failed logins exceeded the threshold (5):
suspicious_logins = result.filter(pw.this.count >= 5)
pw.debug.compute_and_print(suspicious_logins)
And that's it! You have used a tumbling window operation to identify suspicious user activity and can now act on this information to increase the security of your platform.
Reach out to us on Discord if you'd like to discuss real time anomaly detection use cases like this one in more detail!