https://github.com/byronmayne/nugetinsights.connector
A NuGet library that appends telemetry information to figure out how your packages are being used. This does not contain any information that could be tracked back to the user.
https://github.com/byronmayne/nugetinsights.connector
Last synced: 3 months ago
JSON representation
A NuGet library that appends telemetry information to figure out how your packages are being used. This does not contain any information that could be tracked back to the user.
- Host: GitHub
- URL: https://github.com/byronmayne/nugetinsights.connector
- Owner: ByronMayne
- Created: 2025-01-03T19:24:19.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-01-12T04:22:45.000Z (9 months ago)
- Last Synced: 2025-01-12T04:26:15.044Z (9 months ago)
- Language: PowerShell
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NugetInsights.Collector
Gain insights into how your NuGet packages are being used.
As a NuGet package developer, I often wondered whether my packages were being used and how they were performing. To address this curiosity and stay motivated, I decided to add lightweight telemetry to my packages. NugetInsights.Collector simplifies this process for package developers by providing an easy way to collect usage data.
# How it works
NugetInsights.Collector adds an `init.ps1` PowerShell script to the tools folder of the generated NuGet package. This script is automatically executed by the NuGet package manager whenever the package is installed. When executed, the script sends a telemetry event to an Azure Application Insights instance, which is publicly accessible through Grafana.
Key Features:
* **Transparency**: All collected data is anonymized and cannot be linked to specific users.
* **Open Source**: Don't just take my word for [it—review](./Content/tools/init.ps1) the script yourself. The telemetry process is minimal, using a simple REST request to send data.
## Customization
Currently this posts the information to my Azure subscription however you can changing the following MSBuild property values.
`NugetInsightsInstrumentationKey`: The key to application insights instance
`NugetInsightsIngestionUrl`: The url to the application insights.
```xml
{Application Insights Url}
{Your Key}
```
## Accreditation
Network icons created by Freepik - Flaticon