Skip to content

Commit ed8db0d

Browse files
author
Tyler Nienhouse
committed
[DOCS] Add Telemetry Readme and ChangeLog CAT-66
1 parent be89061 commit ed8db0d

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

ChangeLog.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
### Added
10+
- This ChangeLog!
11+
- Telemetry data (basic information about the execution environment) is now added to the to the request objects being signed which is later read and logged internally by our APIs when the request is received. This allows us to better support our various SDKs and does not send any additional network requests. More information can be found in README.md.

readme.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,3 +243,13 @@ You can find the latest version of the SDK as a self-contained ZIP file in the [
243243
## Examples
244244

245245
Each service has it's own example - you can find them in `Examples` folder of LearnositySDK project. To run them simply invoke static `Simple` method.
246+
247+
## Tracking
248+
In version v0.9.0 we introduced code to track the following information by adding it to the request being signed:
249+
- SDK version
250+
- SDK language
251+
- SDK language version
252+
- Host platform (OS)
253+
- Platform version
254+
255+
We use this data to enable better support and feature planning. All subsequent versions of the SDK shall include this usage tracking.

0 commit comments

Comments
 (0)