Azure / Azure/Azure-Verified-Modules

[Documentation Update]: SFR3 - Category: Telemetry - Deployment/Usage Telemetry

Open
#1,618 7 comments 0 reactions 1 assignee Claimed by @matebarabas View on GitHub
Language: Bicep :muscle: Needs: Core Team :genie: Status: In Triage :mag: Type: Documentation :page_facing_up:
Dominant language
PowerShell
Stars
580
Forks
161
Avg merge
11h 3m
Merged PRs (30d)
15

Description

### Check for previous/existing GitHub issues

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

### Description

The section on telemetry ID can be quite overwhelming for new contributors.
For clarity, contributors do not need to create their own telemetry ID.
Instead, they should use the pre-assigned telemetry ID, which can be found in the BicepResourceModules.csv file on GitHub at this link: https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/BicepResourceModules.csv.

The main task is to incorporate this assigned telemetry ID correctly within a bicep file.
Simplifying this information can help contributors understand the process more easily.

When I first read it, I attempted to create my own telemetry ID for the module based on the description, only to later realize that I needed to use the one assigned in the CSV file.

I also recommend adding a Bicep template example for contributors. It's important to include the `take` function to restrict the telemetry ID to a maximum of 64 characters, as this is already being implemented in some modules and seems practical.

```Bicep
#disable-next-line no-deployments-resources
resource avmTelemetry 'Microsoft.Resources/deployments@2024-03-01' = if (enableTelemetry) {
name: take(
'46d3xbcp.res.elasticsan-elasticsan.${replace('-..--..-', '.', '-')}.${substring(uniqueString(deployment().name, location), 0, 4)}',
64
)
properties: {
mode: 'Incremental'
template: {
'$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
contentVersion: '1.0.0.0'
resources: []
outputs: {
telemetry: {
type: 'String'
value: 'For more information, see https://aka.ms/avm/TelemetryInfo'
}
}
}
}
}
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.