Skip to content

Monitor

Bases: Action

Collects events on hosts and informs Blue Agent.

This action runs automatically at the end of each step. If a Blue agent calls it will have no effect. Host events are cleared from the host after this action runs.

Attributes:

Name Type Description
session int

the session id of the session

agent str

the name of the agent executing the action

Functions

__init__

__init__(session: int, agent: str)

Instantiates Monitor class.

Parameters:

Name Type Description Default
session int

the session id of the session

required
agent str

the name of the agent executing the action

required

execute

execute(state: State) -> Observation

Executes the Monitor Action

Parameters:

Name Type Description Default
state State

The current state of CybORG.

required

Returns:

Name Type Description
obs Observation

The observation to be returned to the Blue Agent. Consists of events collected from all hosts the agent has access to. Events are limited to Network Connection events and Process Creation events.