• MFLIB Measurement Framework Library
  • Documentation Resources
    • Example Jupyter Notebooks
    • FABRIC Learn Site
    • MFLib Python Package Documentation
  • MFLib Installation
    • Instaling via PIP
    • Installing via Source Code
  • Running Without FABlib
    • FastAPI Server on the Measurement Node
    • Direct Client Example
    • Suggested Path Forward
  • Building & Deploying
    • Spinx Documentation
      • Build HTML Documents
      • Build PDF Document
    • Distribution Package
      • Uploading to PyPI
• MFLib Overview
  • MFLib Methods
    • Creating a Slice
    • Init & Instrumentize
    • Service Methods
    • Accessing Experiment Nodes via Bastion Host
• MFLib
  • MFLib
    • MFLib.addMeasNode()
    • MFLib.add_mflib_log_handler()
    • MFLib.download_common_hosts()
    • MFLib.init()
    • MFLib.instrumentize()
    • MFLib.mflib_class_version
    • MFLib.remove_mflib_log_handler()
    • MFLib.set_mflib_logger()
• MFLib Core
  • Core
    • Core.bootstrap_status_file
    • Core.common_hosts_file
    • Core.core_class_version
    • Core.create()
    • Core.download_log_file()
    • Core.download_service_file()
    • Core.get_bootstrap_status()
    • Core.get_mfuser_private_key()
    • Core.grafana_tunnel
    • Core.grafana_tunnel_local_port
    • Core.info()
    • Core.kibana_tunnel
    • Core.kibana_tunnel_local_port
    • Core.local_mfuser_private_key_filename
    • Core.local_mfuser_public_key_filename
    • Core.local_slice_directory
    • Core.log_directory
    • Core.meas_node
    • Core.meas_node_ip
    • Core.remove()
    • Core.set_core_logger()
    • Core.slice_name
    • Core.slice_username
    • Core.start()
    • Core.stop()
    • Core.tunnel_host
    • Core.update()
    • Core.upload_service_directory()
    • Core.upload_service_files()
• MFPortal
  • MFPortal
    • MFPortal.DEFAULT_PORTAL_URL
    • MFPortal.MEAS_NETWORK_NAME
    • MFPortal.MEAS_NODE_NAME
    • MFPortal.MF_REPO_TAG
    • MFPortal.RT_V6
    • MFPortal.add_meas_network()
    • MFPortal.add_meas_network_presubmit()
    • MFPortal.add_meas_node()
    • MFPortal.assign_static_fabnet6_ip()
    • MFPortal.build_meas_node_hosts_ini()
    • MFPortal.check_portal_reachable()
    • MFPortal.clone_measurement_framework_repo()
    • MFPortal.collect_full_register_data()
    • MFPortal.collect_node_info()
    • MFPortal.collect_register_meas_node_args()
    • MFPortal.collect_registered_slice_info()
    • MFPortal.collect_registered_slice_nodes()
    • MFPortal.collect_write_slice_info_args()
    • MFPortal.create_meas_node_slice()
    • MFPortal.get_meas_net()
    • MFPortal.get_portal_login_link()
    • MFPortal.get_unique_slice_name()
    • MFPortal.install_persistent_fabnetv6_routing()
    • MFPortal.meas_fabnet_name()
    • MFPortal.meas_node_self_start()
    • MFPortal.mfportal_class_version
    • MFPortal.minimal_portal_register()
    • MFPortal.minimal_register_data()
    • MFPortal.register_meas_node()
    • MFPortal.register_slice_with_portal()
    • MFPortal.run_bootstrap_ansible()
    • MFPortal.run_bootstrap_script()
    • MFPortal.setup_mfuser_account()
    • MFPortal.setup_mfuser_accounts()
    • MFPortal.submit_slice()
    • MFPortal.write_json_to_node()
    • MFPortal.write_registered_slice_info()
    • MFPortal.write_slice_info()
• MFVis
  • MFVis
    • MFVis.add_dashboard()
    • MFVis.add_interface_name()
    • MFVis.add_node_name()
    • MFVis.add_panel()
    • MFVis.add_time_filter()
    • MFVis.add_timezone_to_url()
    • MFVis.add_var()
    • MFVis.check_node_names()
    • MFVis.check_parameters()
    • MFVis.check_time_filters()
    • MFVis.convert_to_iframe()
    • MFVis.determine_dropdown_values()
    • MFVis.determine_interface_names_dropdown()
    • MFVis.download_graph()
    • MFVis.generate_download_url()
    • MFVis.get_available_node_names()
    • MFVis.get_available_panel_names()
    • MFVis.get_available_time_filter_info()
    • MFVis.get_available_time_filter_names()
    • MFVis.get_dashboard_names()
    • MFVis.get_interface_names()
    • MFVis.get_node_and_interface_names()
    • MFVis.get_panel_names()
    • MFVis.get_system_time()
    • MFVis.get_time_filter_value()
    • MFVis.grafana_base_url
    • MFVis.grafana_dashboard_url()
    • MFVis.grafana_panel_url()
    • MFVis.grafana_panel_url_download()
    • MFVis.grafana_solo_dashboard_url()
    • MFVis.grafana_solo_dashboard_url_download()
    • MFVis.imageViewer()
    • MFVis.init_default_dashboard_info()
    • MFVis.meas_net_info
    • MFVis.mfvis_class_version
    • MFVis.render_graph_url()
    • MFVis.visualize_live_prometheus()
• Node Transport
  • RestNodeAdapter
    • RestNodeAdapter.download_file()
    • RestNodeAdapter.execute()
    • RestNodeAdapter.get_management_ip()
    • RestNodeAdapter.get_name()
    • RestNodeAdapter.get_username()
    • RestNodeAdapter.upload_directory()
    • RestNodeAdapter.upload_file()
• Data Transfer
  • ElkExporter
    • ElkExporter.create_repository()
    • ElkExporter.create_snapshot()
    • ElkExporter.export_snapshot_tar()
    • ElkExporter.generate_scp_download_command()
    • ElkExporter.view_indices()
    • ElkExporter.view_repository()
    • ElkExporter.view_snapshot()
    • ElkExporter.view_snapshot_directory()
  • ElkImporter
    • ElkImporter.import_snapshot()
    • ElkImporter.register_repository()
    • ElkImporter.remove_data()
    • ElkImporter.restore_snapshot()
    • ElkImporter.upload_snapshot()
    • ElkImporter.view_indices()
    • ElkImporter.view_repository()
    • ElkImporter.view_snapshot()
  • ImportTool
    • ImportTool.clone_repository()
    • ImportTool.generate_scp_upload_command()
    • ImportTool.install_docker()
    • ImportTool.setup_docker_app()
    • ImportTool.setup_nat64()
    • ImportTool.start_docker()
    • ImportTool.stop_docker()
  • PrometheusExporter
    • PrometheusExporter.create_snapshot()
    • PrometheusExporter.export_snapshot_tar()
    • PrometheusExporter.generate_scp_download_command()
    • PrometheusExporter.view_snapshot_directory()
  • PrometheusImporter
    • PrometheusImporter.import_snapshot()
    • PrometheusImporter.remove_data()
• MFLib mf_timestamp
  • mf_timestamp
    • mf_timestamp.deploy_influxdb_dashboard()
    • mf_timestamp.download_file_from_influxdb()
    • mf_timestamp.download_timestamp_file()
    • mf_timestamp.download_timestamp_from_influxdb()
    • mf_timestamp.get_event_timestamp()
    • mf_timestamp.get_packet_timestamp()
    • mf_timestamp.get_query_for_csv()
    • mf_timestamp.plot_event_timestamp()
    • mf_timestamp.plot_packet_timestamp()
    • mf_timestamp.read_from_local_file()
    • mf_timestamp.record_event_timestamp()
    • mf_timestamp.record_packet_timestamp()
    • mf_timestamp.upload_timestamp_to_influxdb()