Agent

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

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

from socfaker import SocFaker

sc = SocFaker()

print(sc.agent.ephermeral_id)
print(sc.agent.id)
print(sc.agent.type)
print(sc.agent.name)
print(sc.agent.version)

Agent Class

class socfaker.agent.Agent

Agent class is used to simulate or fake data related to logging agent, similar to Elastic’s Winlogbeat

Attributes:

ephermal_id (str): A unique 8 character length hex ID. id (str): A unique 8 character legnth ID representing the agent ID name (str): The agent name type (str): The agent type, in this case the name of the beat version (str): Current beat version which is 7.8.0

Returns:

Agent: A Elastic beats agent

ephermeral_id

A unique and random ephermal ID that changes

Returns:

str: A unique 8 character length hex ID

id

A agent ID which is typically static across the lifetime of the

agent (per instance of this class)

Returns:

str: A static but unique 8 character length ID representing the agent ID

name

A custom name of the agent

Returns:

str: A custom name of the agent

type

The type of agent.

Options are: ‘filebeat’, ‘auditbeat’, ‘functionbeat’,

‘heartbeat’, ‘winlogbeat’, ‘packetbeat’

Returns:

str: A agent type

version

The agent version

Returns:

str: Currently set to a static value of 7.8.0