Alert

This documentation provides details about the data that can be faked for an Alert.

To retrieve data about a fake Alert you can do the following:

from socfaker import SocFaker

sc = SocFaker()

print(sc.alert.summary)
print(sc.alert.signature_name)
print(sc.alert.type)
print(sc.alert.status)
print(sc.alert.action)
print(sc.alert.direction)
print(sc.alert.location)

Alert Class

class socfaker.alert.Alert
The Alert class is designed to mimc common information contained
within a detection or alert.
Returns:
Alert: A Alert object containing property related to a
detection or alert
action

An action taken based on the alert

Returns:
str: Returns a random action based on the alert
direction

The direction of the alert (network based)

Returns:
str: Random direction of from or to
location

The country the alert originated from

Returns:
str: A random country an alert was generated from
severity_label
severity_level
signature_name

Returns the name of a signature that the Alert triggered upon

Returns:
Str: returns a random alert signature name
status

The current alert status

Returns:
str: Returns whether the alert was successful
or unsuccessful
summary

Returns the summary of an alert

Returns:
str: Returns a string of this instance of an alert.
Contains a status, action, type, direction, and location.
type

Returns an alert type

Returns:
str: Returns a random alert type