csle_collector.client_manager package

Subpackages

• csle_collector.client_manager.dao package
  • Submodules
  • csle_collector.client_manager.dao.arrival_config module
    • ArrivalConfig
      • ArrivalConfig.from_dict()
      • ArrivalConfig.from_json_file()
      • ArrivalConfig.to_dict()
  • csle_collector.client_manager.dao.client module
    • Client
      • Client.copy()
      • Client.from_dict()
      • Client.from_grpc_object()
      • Client.from_json_file()
      • Client.generate_commands()
      • Client.to_dict()
      • Client.to_grpc_object()
  • csle_collector.client_manager.dao.client_arrival_type module
    • ClientArrivalType
      • ClientArrivalType.CONSTANT
      • ClientArrivalType.EPTMP
      • ClientArrivalType.PIECE_WISE_CONSTANT
      • ClientArrivalType.SINE_MODULATED
      • ClientArrivalType.SPIKING
  • csle_collector.client_manager.dao.constant_arrival_config module
    • ConstantArrivalConfig
      • ConstantArrivalConfig.from_dict()
      • ConstantArrivalConfig.from_grpc_object()
      • ConstantArrivalConfig.from_json_file()
      • ConstantArrivalConfig.to_dict()
      • ConstantArrivalConfig.to_grpc_object()
  • csle_collector.client_manager.dao.eptmp_arrival_config module
    • EPTMPArrivalConfig
      • EPTMPArrivalConfig.from_dict()
      • EPTMPArrivalConfig.from_grpc_object()
      • EPTMPArrivalConfig.from_json_file()
      • EPTMPArrivalConfig.to_dict()
      • EPTMPArrivalConfig.to_grpc_object()
  • csle_collector.client_manager.dao.piece_wise_constant_arrival_config module
    • PieceWiseConstantArrivalConfig
      • PieceWiseConstantArrivalConfig.from_dict()
      • PieceWiseConstantArrivalConfig.from_grpc_object()
      • PieceWiseConstantArrivalConfig.from_json_file()
      • PieceWiseConstantArrivalConfig.to_dict()
      • PieceWiseConstantArrivalConfig.to_grpc_object()
  • csle_collector.client_manager.dao.sine_arrival_config module
    • SineArrivalConfig
      • SineArrivalConfig.from_dict()
      • SineArrivalConfig.from_grpc_object()
      • SineArrivalConfig.from_json_file()
      • SineArrivalConfig.to_dict()
      • SineArrivalConfig.to_grpc_object()
  • csle_collector.client_manager.dao.spiking_arrival_config module
    • SpikingArrivalConfig
      • SpikingArrivalConfig.from_dict()
      • SpikingArrivalConfig.from_grpc_object()
      • SpikingArrivalConfig.from_json_file()
      • SpikingArrivalConfig.to_dict()
      • SpikingArrivalConfig.to_grpc_object()
  • csle_collector.client_manager.dao.workflow_markov_chain module
    • WorkflowMarkovChain
      • WorkflowMarkovChain.copy()
      • WorkflowMarkovChain.from_dict()
      • WorkflowMarkovChain.from_grpc_object()
      • WorkflowMarkovChain.from_json_file()
      • WorkflowMarkovChain.markov_next_state()
      • WorkflowMarkovChain.reset()
      • WorkflowMarkovChain.step_forward()
      • WorkflowMarkovChain.to_dict()
      • WorkflowMarkovChain.to_grpc_object()
  • csle_collector.client_manager.dao.workflow_service module
    • WorkflowService
      • WorkflowService.copy()
      • WorkflowService.create_execution_config()
      • WorkflowService.from_dict()
      • WorkflowService.from_grpc_object()
      • WorkflowService.from_json_file()
      • WorkflowService.get_commands()
      • WorkflowService.replace_first_octet_of_ip()
      • WorkflowService.to_dict()
      • WorkflowService.to_grpc_object()
  • csle_collector.client_manager.dao.workflows_config module
    • WorkflowsConfig
      • WorkflowsConfig.commands()
      • WorkflowsConfig.copy()
      • WorkflowsConfig.create_execution_config()
      • WorkflowsConfig.from_dict()
      • WorkflowsConfig.from_grpc_object()
      • WorkflowsConfig.from_json_file()
      • WorkflowsConfig.get_workflow_mc()
      • WorkflowsConfig.get_workflow_service()
      • WorkflowsConfig.to_dict()
      • WorkflowsConfig.to_grpc_object()
  • Module contents
• csle_collector.client_manager.threads package
  • Submodules
  • csle_collector.client_manager.threads.arrival_thread module
    • ArrivalThread
      • ArrivalThread.constant_poisson_rate()
      • ArrivalThread.eptmp_rate()
      • ArrivalThread.piece_wise_constant_rate()
      • ArrivalThread.run()
      • ArrivalThread.sine_modulated_poisson_rate()
      • ArrivalThread.spiking_poisson_arrival_rate()
  • csle_collector.client_manager.threads.client_thread module
    • ClientThread
      • ClientThread.run()
  • csle_collector.client_manager.threads.producer_thread module
    • ProducerThread
      • ProducerThread.run()
  • Module contents

Submodules

csle_collector.client_manager.client_manager module

class csle_collector.client_manager.client_manager.ClientManagerServicer

Bases: ClientManagerServicer

gRPC server for managing the running clients. Allows to start/stop clients remotely and also to query the state of the clients.

getClients(request: GetClientsMsg, context: ServicerContext) → ClientsDTO

Gets the state of the clients

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the clients

get_arrival_thread() → Union[None, ArrivalThread]

Gets the arrival thread

Returns

The arrival thread if it is initialized, otherwise None

get_producer_thread() → Union[None, ProducerThread]

Gets the producer thread

Returns

The producer thread if it is initialized, otherwise None

startClients(request: StartClientsMsg, context: ServicerContext) → ClientsDTO

Starts/Restarts the Poisson process(es) that generate(s) clients

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the clients

startProducer(request: StartProducerMsg, context: ServicerContext) → ClientsDTO

Starts/Restarts the producer thread that pushes data to Kafka

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the clients

stopClients(request: StopClientsMsg, context: ServicerContext)

Stops the Poisson-process that generates new clients

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the clients

stopProducer(request: StopProducerMsg, context: ServicerContext) → ClientsDTO

Stops the producer thread that pushes data to Kafka

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the clients

csle_collector.client_manager.client_manager.serve(port: int = 50044, log_dir: str = '/', log_file_name: str = 'client_manager.log', max_workers: int = 10) → None

Starts the gRPC server for managing clients

Parameters

• port – the port that the server will listen to

• log_dir – the directory to write the log file

• log_file_name – the file name of the log

• max_workers – the maximum number of GRPC workers

Returns

None

csle_collector.client_manager.client_manager_pb2 module

Generated protocol buffer code.

csle_collector.client_manager.client_manager_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class csle_collector.client_manager.client_manager_pb2_grpc.ClientManager

Bases: object

Interface exported by the server

static getClients(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startClients(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static startProducer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopClients(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

static stopProducer(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)

class csle_collector.client_manager.client_manager_pb2_grpc.ClientManagerServicer

Bases: object

Interface exported by the server

getClients(request, context)

Missing associated documentation comment in .proto file.

startClients(request, context)

Missing associated documentation comment in .proto file.

startProducer(request, context)

Missing associated documentation comment in .proto file.

stopClients(request, context)

Missing associated documentation comment in .proto file.

stopProducer(request, context)

Missing associated documentation comment in .proto file.

class csle_collector.client_manager.client_manager_pb2_grpc.ClientManagerStub(channel)

Bases: object

Interface exported by the server

csle_collector.client_manager.client_manager_pb2_grpc.add_ClientManagerServicer_to_server(servicer, server)

csle_collector.client_manager.client_manager_util module

class csle_collector.client_manager.client_manager_util.ClientManagerUtil

Bases: object

Class with utility functions related to the Client Manager

static client_dto_to_dict(clients_dto: ClientsDTO) → Dict[str, Any]

Converts a ClientsDTO to a dict

Parameters

clients_dto – the dto to convert

Returns

a dict representation of the DTO

static clients_dto_empty() → ClientsDTO

Returns

an empty ClientsDTO

static clients_dto_from_dict(d: Dict[str, Any]) → ClientsDTO

Converts a dict representation of a ClientsDTO to a DTO

Parameters

d – the dict to convert

Returns

the converted DTO

csle_collector.client_manager.client_population_metrics module

class csle_collector.client_manager.client_population_metrics.ClientPopulationMetrics(ip: str = '', ts: float = 1739104500.074135, num_clients: int = 0, rate: float = 20, service_time: float = 4)

Bases: JSONSerializable

DTO representing information about the client population

copy() → ClientPopulationMetrics

Returns

a copy of the object

static from_dict(d: Dict[str, Any]) → ClientPopulationMetrics

Converts a dict representation of the object into an instance :param d: the dict representation :return: the created instance

static from_json_file(json_file_path: str) → ClientPopulationMetrics

Reads a json file and converts it to a DTO

Parameters

json_file_path – the json file path

Returns

the converted DTO

static from_kafka_record(record: str) → ClientPopulationMetrics

Converts a kafka record to a DTO

Parameters

record – the kafka record

Returns

the DTO

get_deltas(stats_prime: ClientPopulationMetrics) → Tuple[List[float], List[str]]

Get the deltas between two stats objects

Parameters

stats_prime – the stats object to compare with

Returns

the deltas and the labels

get_values() → Tuple[List[float], List[str]]

Get the current values

Returns

the values and the labels

num_attributes() → int

Returns

The number of attributes of the DTO

static schema() → ClientPopulationMetrics

Returns

get the schema of the DTO

to_dict() → Dict[str, Any]

Converts the object to a dict representation

Returns

a dict representation of the object

update_with_kafka_record(record: str) → None

Updates the DTO with a new kafka record

Parameters

record – the kafka record

Returns

None

csle_collector.client_manager.query_clients module

csle_collector.client_manager.query_clients.get_clients(stub: ClientManagerStub, timeout=60) → ClientsDTO

Queries the server for the client state

Parameters

• stub – the stub to send the remote gRPC to the server

• timeout – the GRPC timeout (seconds)

Returns

a clientsDTO describing the state of the clients

csle_collector.client_manager.query_clients.start_clients(stub: ClientManagerStub, time_step_len_seconds: int, workflows_config: WorkflowsConfig, clients: List[Client], timeout=60) → ClientsDTO

Starts the client arrival process

Parameters

• stub – the stub to the gRPC server

• time_step_len_seconds – length of a time-step in the emulation

• workflows_config – configuration of the workflows

• clients – list of client profiles

• timeout – the timeout for sending a request to the GRPC server

Returns

a clients DTO describing the state of the clients

csle_collector.client_manager.query_clients.start_producer(stub: ClientManagerStub, ip: str, port: int, time_step_len_seconds: int, timeout=60)

Stops the producer process

Parameters

• stub – the stub to the gRPC server

• ip – ip of the kafka server to produce to

• port – port of the kafka server to produce to

• timeout – the GRPC timeout (seconds)

Returns

a clientsDTO describing the state of the clients

csle_collector.client_manager.query_clients.stop_clients(stub: ClientManagerStub, timeout=60)

Stops the client arrival process

Parameters

• stub – the stub to the gRPC server

• timeout – the GRPC timeout (seconds)

Returns

a clientsDTO describing the state of the clients

csle_collector.client_manager.query_clients.stop_producer(stub: ClientManagerStub, timeout=60)

Stops the producer process

Parameters

• stub – the stub to the gRPC server

• timeout – the GRPC timeout (seconds)

Returns

a clientsDTO describing the state of the clients

Module contents