Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 3.29 KB

stats.md

File metadata and controls

45 lines (31 loc) · 3.29 KB
Raw

Stats

Syntax: tf-profile stats [options] [log_file]

Description: reads a Terraform log file and print high-level information about the run.

Options:

  • -t, --tee: print logs while parsing them. Shorthand for terraform apply | tee >(tf-profile stats). Default: false
  • -a, --aggregate: enable or disable aggregation of resources created by the same for_each or count expression. Default: true

Arguments:

  • log_file: Optional. Instruct tf-profile to read input from a text file instead of stdin.

Description

The following statistics will be printed:

General:

  • Number of resources created: Number of resources detected in your log. Depending on which phases (refresh, plan, apply) were present in the log, this number can differ and may not always match what is defined in your code. For example, doing terraform apply my_plan_file will not include a resource that is not to be modified in this plan.

Duration:

  • Cumulative duration: Cumulative duration of modifications. This is the sum of the duration of all modifications in the logs. Because Terraform modifies resources in parallel, this will typically be more than the actual wall time.
  • Longest apply time: Longest time it took to modify a single resource. The next metric shows which resource that was.
  • Longest apply resource: The name of the resource that took the most time to modify.

Operations:

  • Resources marked for operation <OPERATION>: The amount of resources marked for a certain operation. An Operation can be any of: Create, Destroy, Modify, Replace, None. Resources that are consistent with the state, will be marked for operation None.

Resource status:

  • Resources in state <STATE>: This statistic shows per state how many resources are in that state after the modifications. In general, resources can be in three states after a Terraform run: Created, NotCreated or Failed.

Desired state:

  • Resources in desired state: The amount of resources whose final_state is equal to their desired_state. In a fully applied configuration, this number should be 100%.
  • Resources not in desired state: Resources whose desired state was not achieved after this run. This can be due to failed creation, failed deletion or because "upstream" resources were not able to get to their desired state.

Modules:

  • Number of top-level modules: Number of modules called in the root module.
  • Largest top-level module: Name of the largest top-level module.
  • Size of largest top-level module: Number of resources in this largest top-level module. Note that this number includes all resources in submodules as well.
  • Deepest module: Name of the deepest nested module. For example. module.a.module.b is two levels deep, but module.a.module.b.module.c is three levels deep. If multiple modules are equally as deep, the first one detected in the log will be printed.
  • Deepest module depth: The depth of the module in the previous statistic.
  • Largest leaf module: A module is considered a "leaf module", if it does not make any recursive module calls. This metric prints the name of the largest leaf module.
  • Size of largest leaf module: Number of resources in the largest leaf module. As a leaf module has no submodules, these are only the resources created directly inside this leaf module.