Skip to content

Add initial tenets #1265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add initial tenets #1265

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8827c3
Add initial tenets
varunnvs92 May 23, 2019
c37d3e1
Updated tenets after internal meeting
varunnvs92 May 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/design/core/metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
**Design:** New Feature, **Status:**
[In Development](../../../README.md)

# SDK Tenets (unless you know better ones)

1. Collected metrics are easy to understand
2. Metrics can be compared overtime and gives insights into application behavior (provides value to customer)
3. Adding metrics should have minimal impact on the application performance
4. Customers can easily access published metrics
5. Verbosity of metrics should be kept to minimum in logs


# Project Introduction

This project introduces a feature that can collect and report SDK metrics data in your application.
These metrics can be used to gather insights into your application and tune the application for
the best performance. The metrics can help in debugging when the application is experiencing
high error rates.