Azure / Azure/Azure-Landing-Zones

Confusing/redundant variables: `enable_telemetry` and `disable_telemetry`

Open
#552 3 comments 1 reaction 1 assignee Claimed by @matt-FFFFFF View on GitHub
Product: Sub/LZ Vending (TF) Topic: Non-Resource Specific :label: Transfer From: TF avm-ptn-lz-vend :arrow_right:
Dominant language
PowerShell
Stars
96
Forks
70
Avg merge
3d 1h
Merged PRs (30d)
7

Description

### Check for previous/existing GitHub issues

- [x] I have checked for previous/existing GitHub issues

### Issue Type?

Bug

### (Optional) Module Version

0.1.0

### (Optional) Correlation Id

_No response_

### Description

The module currently has the following confusing and contradictory input variables:

> **disable_telemetry:**
>
> To disable tracking, we have included this variable with a simple boolean flag.
> The default value is `false` which does not disable the telemetry.
> If you would like to disable this tracking, then simply set this value to true and this module will not create the telemetry tracking resources and therefore telemetry tracking will be disabled.
>
> **enable_telemetry:**
>
> This variable controls whether or not telemetry is enabled for the module.
> For more information see .
> If it is set to false, then no telemetry will be collected.

Neither of these appears to be deprecated and neither works entirely as described. `disable_telemetry` disables telemetry on the role assignment and virtual network sub-modules whereas `enable_telemetry` governs whether the `modtm_telemetry.telemetry` resource is created in the main module.

One of these input variables should take precedence over the other, and one of them should be deprecated and removed in the next major version increment.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.