Overview of Features

The CloudZero CostFormation Toolkit extension supports you through all aspects of authoring custom CloudZero Dimensions, including downloading, validating, and publishing of your custom definitions.

The following are brief descriptions of the available features. More in-depth information on how to use these features can be found later in this page.

Autocompletion

Several of the definition language constructs can be automatically completed with VSCode autocomplete functionality. Autocomplete provides templates for things like rules and transforms as well as dynamic source information such as resource tags or Kubernetes labels by using live data from the CloudZero platform.

Inline Static Validation

While editing your definition files, the extension provides inline static validation as you type. This validation will immediately alert you with visual cues when you have ill formatted YAML or have structural and/or syntactic errors in your definitions.

Definition Downloading

The extension can retrieve the current live definitions so you can be sure you are editing the latest definitions. The extension can also download older versions of the definitions to allow you to view previous versions or even rollback some definitions.

Line-By-Line Diff

When editing your definitions, you can review your changes with a line-by-line diff of your current edits against the currently published definitions.

Telemetry Code Lens

To provide more context when editing dimensions, this feature will display an annotation above the definition of any dimension that is referenced by a telemetry stream.

A telemetry stream tracks usage for the elements of one or more dimensions. If one of those referenced dimensions is removed, it will render the stream invalid and unavailable for use in authoring Allocation dimensions. Clicking on the inline annotation will open the Telemetry Streams page for your organization, where you can see detailed information about each telemetry stream.

The code lens can be toggled on and off. To do so, Open the Settings UI (Code › Settings › Settings) and uncheck the Code Lens › Telemetry: Enable setting.

Full Validation

While the inline static validation provides immediate feedback as you type, when you save a definitions file locally, the CloudZero platform provide full validation, including validation of sources, cycles in your dependencies, etc.

Publishing

When you have finished creating your definitions, you can publish them directly to the CloudZero platform, making your definitions available to all of your CloudZero users through the CloudZero Cost Explorer.

Restoring Older Definitions

If you have published a set of definitions that turn out to have a problem, you can back out your changes by restoring your definitions to a previous version.