# Diagnostics


# Functions

top-level functions:                                                                                                                                                       

prefect.utilities.diagnostics.diagnostic_info

(flow=None, include_secret_names=False)[source]

Get full diagnostic information

Args:

  • flow ("prefect.Flow", optional): the flow whose attributes to retrieve. If no flow is provided then flow information will not be present in output.
  • include_secret_names (bool, optional): toggle output of Secret names, defaults to False. Note: Secret values are never returned, only their names.
Returns:
  • str: a string representation of the full diagnostic information

prefect.utilities.diagnostics.flow_information

(flow)[source]

Get flow information

Args:

  • flow ("prefect.Flow"): the flow whose attributes to retrieve
Returns:
  • dict: a dictionary of informative flow attributes

prefect.utilities.diagnostics.system_information

()[source]

Get system information

Returns:

  • dict: a dictionary containing some system information

prefect.utilities.diagnostics.config_overrides

(include_secret_names=False)[source]

Get user configuration keys that differ from the default configuration. Will only return an indication if a key is set and differs from the defaults, values are not returned.

Args:

  • include_secret_names (bool, optional): toggle inclusion of secret config keys in the output. Note that secret values are never returned, only their names when this is True. Defaults to False.
Returns:
  • dict: a dictionary containing names of user configuration overrides

prefect.utilities.diagnostics.environment_variables

()[source]

Get PREFECT__ specific environment variables

Returns:

  • dict: a dictionary containing names of set Prefect environment variables

This documentation was auto-generated from commit n/a
on February 23, 2022 at 19:26 UTC