kafka_overwatch.reporting package

Subpackages

Submodules

kafka_overwatch.reporting.schema_registry module

kafka_overwatch.reporting.schema_registry. get_schema_registry_report ( topics_df , kafka_cluster ) [source]

Generate schema registry.

Return type :

typing.Optional [ kafka_overwatch.specs.report.SchemaRegistryReport ]

kafka_overwatch.reporting.tools module

kafka_overwatch.reporting.tools. export_df ( kafka_cluster , df , resource_name ) [source]

If DF exporters are set, write/export to these.

Return type :

None

kafka_overwatch.reporting.tools. output_dataframe ( kafka_cluster , content , file_name , mime_type ) [source]

Writes dataframe to S3 or to local disk (or both)

kafka_overwatch.reporting.topics module

kafka_overwatch.reporting.topics. process_cluster_topic_df ( topics_df ) [source]
Return type :

dict

Module contents

kafka_overwatch.reporting. get_cluster_governance ( governance_config , topics_df , groups_df ) [source]
Return type :

kafka_overwatch.specs.report.Governance

kafka_overwatch.reporting. get_cluster_usage ( cluster_name , kafka_cluster , topics_df , groups_df ) [source]

Based on the topics to monitor, as per the configuration, evaluates the usage of the topics identified.

Return type :

kafka_overwatch.specs.report.ClusterReport

kafka_overwatch.reporting. get_naming_convention_report ( topics_df , governance_config ) [source]
Return type :

kafka_overwatch.specs.report.GovernanceNamingConventionReport

kafka_overwatch.reporting. set_cluster_topic_stats ( topics_df ) [source]

Generates the topic stats and waste report

Return type :

tuple [ kafka_overwatch.specs.report.Statistics , kafka_overwatch.specs.report.EstimatedWaste ]