csle_collector.kafka_manager package

Submodules

csle_collector.kafka_manager.kafka_manager module

class csle_collector.kafka_manager.kafka_manager.KafkaManagerServicer

Bases: csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerServicer

gRPC server for managing a Kafka server. Allows to start/stop the kafka server remotely and also to query the state of the server and create/delete topics.

createTopic(request: kafka_manager_pb2.CreateTopicMsg, context: grpc.ServicerContext) → kafka_manager_pb2.KafkaDTO

Creates a new Kafka topic

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the kafka server

getKafkaStatus(request: kafka_manager_pb2.GetKafkaStatusMsg, context: grpc.ServicerContext) → kafka_manager_pb2.KafkaDTO

Gets the state of the kafka server

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the kafka server

startKafka(request: kafka_manager_pb2.StartKafkaMsg, context: grpc.ServicerContext) → kafka_manager_pb2.KafkaDTO

Starts the kafka server

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the kafka server

stopKafka(request: kafka_manager_pb2.StopKafkaMsg, context: grpc.ServicerContext)

Stops the kafka server

Parameters

• request – the gRPC request

• context – the gRPC context

Returns

a clients DTO with the state of the kafka server

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

Starts the gRPC server for managing the kafka server

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.kafka_manager.kafka_manager_pb2 module

Generated protocol buffer code.

csle_collector.kafka_manager.kafka_manager_pb2_grpc module

Client and server classes corresponding to protobuf-defined services.

class csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManager

Bases: object

Interface exported by the server

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

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

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

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

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

class csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerServicer

Bases: object

Interface exported by the server

createTopic(request, context)

Missing associated documentation comment in .proto file.

deleteTopic(request, context)

Missing associated documentation comment in .proto file.

getKafkaStatus(request, context)

Missing associated documentation comment in .proto file.

startKafka(request, context)

Missing associated documentation comment in .proto file.

stopKafka(request, context)

Missing associated documentation comment in .proto file.

class csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerStub(channel)

Bases: object

Interface exported by the server

csle_collector.kafka_manager.kafka_manager_pb2_grpc.add_KafkaManagerServicer_to_server(servicer, server)

csle_collector.kafka_manager.kafka_manager_util module

class csle_collector.kafka_manager.kafka_manager_util.KafkaManagerUtil

Bases: object

Class with utility functions related to the Kafka Manager

static hours_to_ms(hours: float) → float

Convert hours to ms

Parameters

hours – the hours to convert

Returns

the ms

static kafka_dto_empty() → kafka_manager_pb2.KafkaDTO

Returns

an empty KafkaDTO

static kafka_dto_from_dict(d: Dict[str, Any]) → kafka_manager_pb2.KafkaDTO

Converts a dict representation of a KafkaDTO to a DTO

Parameters

d – the dict to convert

Returns

the converted DTO

static kafka_dto_to_dict(kafka_dto: kafka_manager_pb2.KafkaDTO) → Dict[str, Any]

Converts a KafkaDTO to a dict

Parameters

kafka_dto – the dto to convert

Returns

a dict representation of the DTO

csle_collector.kafka_manager.query_kafka_server module

csle_collector.kafka_manager.query_kafka_server.create_topic(stub: csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerStub, name: str, partitions: int, replicas: int, retention_time_hours: int, timeout=60) → kafka_manager_pb2.KafkaDTO

Sends a request to the KafkaManager to create a new Kafka topic

Parameters

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

• name – the name of the Kafka topic

• partitions – the number of partitions of the Kafka topic

• replicas – the number of replicas of the Kafka topic

• retention_time_hours – the retention time for the topic

• timeout – the GRPC timeout (seconds)

Returns

a KafkaDTO describing the status of the kafka server

csle_collector.kafka_manager.query_kafka_server.get_kafka_status(stub: csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerStub, timeout=60) → kafka_manager_pb2.KafkaDTO

Queries the server for the kafka server status

Parameters

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

• timeout – the GRPC timeout (seconds)

Returns

a KafkaDTO describing the status of the kafka server

csle_collector.kafka_manager.query_kafka_server.start_kafka(stub: csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerStub, timeout=60) → kafka_manager_pb2.KafkaDTO

Sends a request to the Kafka server to start the Kafka server

Parameters

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

• timeout – the GRPC timeout (seconds)

Returns

a KafkaDTO describing the status of the kafka server

csle_collector.kafka_manager.query_kafka_server.stop_kafka(stub: csle_collector.kafka_manager.kafka_manager_pb2_grpc.KafkaManagerStub, timeout=60) → kafka_manager_pb2.KafkaDTO

Sends a request to the Kafka server to stop the Kafka server

Parameters

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

• timeout – the GRPC timeout (seconds)

Returns

a KafkaDTO describing the status of the kafka server

Module contents