App insights Telemetry for Commands #409
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: Download Info | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| print-download-info: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Check out code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.x' # Replace with the desired Python version | ||
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install requests | ||
|
|
||
| - name: Get Download Info | ||
| run: | | ||
| python - <<EOF | ||
| import requests | ||
|
|
||
| url = "https://github.com/api/repos/microsoft/go-sqlcmd/releases" | ||
| response = requests.get(url) | ||
| data = response.json() | ||
|
|
||
| for release in data: | ||
| for asset in release['assets']: | ||
| browser_download_url = asset['browser_download_url'] | ||
| download_count = asset['download_count'] | ||
| print("Download URL:", browser_download_url) | ||
| print("Download Count:", download_count) | ||
| print() | ||
| EOF |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| package telemetry | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/microsoft/ApplicationInsights-Go/appinsights" | ||
| ) | ||
|
|
||
| var telemetryClient appinsights.TelemetryClient | ||
|
|
||
| func SetTelemetryClient(client appinsights.TelemetryClient) { | ||
| telemetryClient = client | ||
| } | ||
|
|
||
| func SetTelemetryClientFromInstrumentationKey(instrumentationKey string) { | ||
| telemetryClient = appinsights.NewTelemetryClient(instrumentationKey) | ||
| } | ||
|
|
||
| type Telemetry struct { | ||
| Client appinsights.TelemetryClient | ||
| } | ||
|
|
||
| func InitializeAppInsights() { | ||
| instrumentationKey := "3fdeec77-2951-456f-bcb2-9f003b512a3f" | ||
| config := appinsights.NewTelemetryConfiguration(instrumentationKey) | ||
| telemetryClient = appinsights.NewTelemetryClientFromConfig(config) | ||
| SetTelemetryClient(telemetryClient) | ||
| // Add a diagnostics listener for printing telemetry messages | ||
| appinsights.NewDiagnosticsMessageListener(func(msg string) error { | ||
| fmt.Printf("[%s] %s\n", time.Now().Format(time.UnixDate), msg) | ||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| // TrackCommand tracks a command execution event | ||
| func TrackCommand(command string) { | ||
| event := appinsights.NewEventTelemetry("command") | ||
|
There was a problem hiding this comment. Do we need a hierarchy/categorized name for events and properties so we can group things? Eg in SSMS there are multiple events that happen to an object explorer node. The event names are There are also a bunch of "ambient" properties we tried to include in most events, like the type of server OE is connected to. In our case, I feel like Also - for "modern" commands we should log the context id (a guid) with every relevant event. That will enable us to track the lifecycle of a context. EG if the customer runs sqlcmd to create a context, there should be an event that logs the context id guid along with non-PII metadata about the context (container type, operating system of the host, version of SQL, etc). Subsequent commands using that context can then be correlated with that creation. If the user uses an existing context for an operation, we can log a 'ConnectContext' event that has the similar metadata as the |
||
| event.Properties["command"] = command | ||
| telemetryClient.Track(event) | ||
| } | ||
|
|
||
| // TrackSubCommand tracks a sub-command execution event | ||
| func TrackSubCommand(command, subCommand string) { | ||
| event := appinsights.NewEventTelemetry("sub-command") | ||
| event.Properties["command"] = command | ||
| event.Properties["sub-command"] = subCommand | ||
| telemetryClient.Track(event) | ||
| } | ||
|
|
||
| func TrackEvent(eventName string, properties map[string]string) { | ||
| event := appinsights.NewEventTelemetry(eventName) | ||
| for key, value := range properties { | ||
| event.Properties[key] = value | ||
| } | ||
| telemetryClient.Track(event) | ||
| } | ||
|
|
||
| func CloseTelemetry() { | ||
| telemetryClient.Channel().Close() | ||
| } | ||
| func FlushTelemetry() { | ||
| telemetryClient.Channel().Flush() | ||
| } | ||
|
|
||
| func LogMessage(msg string) error { | ||
| fmt.Printf("[%s] %s\n", time.Now().Format(time.UnixDate), msg) | ||
| return nil | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it could be useful to define a method that accepts event name and properties plus a func() as input. It would run the function with a timer and add an elapsed time property to the telemetry event before posting it.
Something like
then we can measure how long it takes to deploy things without trying to look for a "begin" event and its corresponding "end" event.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good suggestion , but i would like to add one POV here . Instead of every granular event to have start and end time , we should have these func parmater with specified events (such as deploy and create).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes I don't think every operation needs an elapsed time property, just certain ones. At the lowest level, though, the function just needs to take an event name and properties. The application-level code will decide which events need to use it.