blueprint v0.3.0 Blueprint.Plot

Convenience functions for creating different graphs from a blueprint.

Link to this section Summary

Link to this section Functions

Link to this function application_graph(blueprint, opts \\ [])
application_graph(Blueprint.t(), keyword()) :: Blueprint.t()

Create an application graph.

Options can be provided to change the resulting graph. These options are any that are valid in Blueprint.Plot.Graph.to_dot/2 or any mentioned below:

  • :detail - Affects the level of detail of the generated graph. Valid values are :high or :low.
  • :annotate - Any additional annotations to be made. Valid values are an atom or list of atoms. The currently supported annotation options are:

    • :version - To display the application’s version.
    • :messages - To include messages sent between nodes.
  • :name - The name of the DOT file to be saved.
Link to this function function_graph(blueprint, app_or_opts \\ [], opts \\ [])
function_graph(Blueprint.t(), atom() | keyword(), keyword()) :: Blueprint.t()

Create a function graph.

This can either be for the entire blueprint or for a given application.

Options can be provided to change the resulting graph. These options are any that are valid in Blueprint.Plot.Graph.to_dot/2 or any mentioned below:

  • :detail - Affects the level of detail of the generated graph. Valid values are :high or :low.
  • :name - The name of the DOT file to be saved.
Link to this function message_graph(blueprint, app_or_opts \\ [], opts \\ [])
message_graph(Blueprint.t(), atom() | keyword(), keyword()) :: Blueprint.t()

Create a message graph.

This can either be for the entire blueprint or for a given application.

Options can be provided to change the resulting graph. These options are any that are valid in Blueprint.Plot.Graph.to_dot/2 or any mentioned below:

  • :name - The name of the DOT file to be saved.
Link to this function module_graph(blueprint, app_or_opts \\ [], opts \\ [])
module_graph(Blueprint.t(), atom() | keyword(), keyword()) :: Blueprint.t()

Create a module graph.

This can either be for the entire blueprint or for a given application.

Options can be provided to change the resulting graph. These options are any that are valid in Blueprint.Plot.Graph.to_dot/2 or any mentioned below:

  • :detail - Affects the level of detail of the generated graph. Valid values are :high or :low.
  • :annotate - Any additional annotations to be made. Valid values are an atom or list of atoms. The currently supported annotation options are:

    • :version - To display the module’s version.
    • :messages - To include messages sent between nodes.
  • :name - The name of the DOT file to be saved.