Skip to content

Add telemetry API and initial set of events#2922

Merged
compulim merged 43 commits intomicrosoft:masterfrom
compulim:feat-telemetry
Feb 26, 2020
Merged

Add telemetry API and initial set of events#2922
compulim merged 43 commits intomicrosoft:masterfrom
compulim:feat-telemetry

Conversation

@compulim
Copy link
Copy Markdown
Contributor

@compulim compulim commented Feb 19, 2020

Fixes #2754.

Changelog Entry

Added

Description

This is an initial work, which will enable us to add more metrics sooner.

Although we emit metrics, we do not collect them and there is no default telemetry collector, a.k.a. it just go to void.

While this feature is optional, developers who are interested in our telemetry data will need to write code to integrate our telemetry collection API with service of their choice. If developers decided to collect any data, they should also provide privacy policy to their end-user.

We support 3 types of metrics: event, exception, and timing.

Specific Changes

  • Added 4 telemetry hooks
    • useTelemetryDimension, useTelemetryEvent, useTelemetryException, and useTelemetryTiming
  • Added telemetry dimensions
    • prop:locale, prop:speechRecognition, prop:speechSynthesis, capability:downscaleImage:workerType
  • Added telemetry events
    • init, sendFiles, submitSendBox
  • Added telemetry timing
    • sendFiles:makeThumbnail
  • Added 2 samples to integrate with Azure Application Insights and Google Analytics

To-do

  • Add <ErrorBoundary> for fatal error

  • Testing Added

Comment thread samples/04.api/k.telemetry/index.html Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread packages/component/src/Tracker.js Outdated
@compulim compulim changed the title [DRAFT] Add telemetry API and initial set of events Add telemetry API and initial set of events Feb 22, 2020
@compulim compulim marked this pull request as ready for review February 22, 2020 10:17
Comment thread docs/HOOKS.md Outdated
Comment thread docs/TELEMETRY.md
Comment thread docs/HOOKS.md Outdated
Comment thread docs/HOOKS.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread docs/HOOKS.md Outdated
Comment thread docs/TELEMETRY.md Outdated
Comment thread packages/component/src/BasicWebChat.js Outdated
Comment thread packages/component/src/BasicWebChat.js
Comment thread packages/component/src/ErrorBoundary.js
Comment thread packages/component/src/Tracker.js
@compulim compulim merged commit 1ac2aaa into microsoft:master Feb 26, 2020
@compulim compulim deleted the feat-telemetry branch February 26, 2020 01:13
@compulim compulim mentioned this pull request Mar 5, 2020
40 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IC3] Pluggable telemetry

3 participants