nanoframework/Home

Add telemetry for VS extension and tools

Open

#854 opened on Oct 6, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees) (89 forks)auto 404
Area: ToolsHacktoberfestPriority: Lowup-for-grabs

Repository metrics

Stars
 (936 stars)
PR merge metrics
 (PR metrics pending)

Description

Details about Problem

nanoFramework area: ( Visual Studio extension | Other tools )

VS version: All

VS extension version: All

Target: N/A

Firmware image version: N/A

Description

Although Telemetry can be deemed controversial, we are an open source project and need this data in order to improve certain aspects of nanoFramework. It would be beneficial to add it in certain areas. Namely this would involve:

  • nanoff (nanoFirmwareFlasher)
  • VS Extension (nanoFramework)
  • VS Code Extension (nanoFramework)

Although "opt-in" would be preferential, it is unlikely (with the current userbase) to attract enough support to give enough detail. We should consider a commercial option to allow "opt-out".

Most viable solution is to follow https://learn.microsoft.com/en-us/dotnet/core/diagnostics/observability-with-otel and https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=net

Contributor guide

Research direction
Explore how to implement OpenTelemetry based telemetry in the nanoFramework VS extension, nanoff CLI, and VS Code extension, following the Microsoft documentation on observability with OpenTelemetry and Azure Monitor. Start by reviewing the existing codebase of each tool to understand where telemetry calls can be injected, then design a common telemetry client with opt out support.
Tech stack
csharptypescript
Domain
developer experienceobservabilitytooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitC#OpenTelemetry
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40