Skip to content
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

Create design-update.md #40

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Create design-update.md #40

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc4fcc6
Create design-update.md
satra Feb 10, 2022
2af4271
Update design-update.md
satra Feb 10, 2022
5224eb0
Update docs/design-update.md
satra Feb 11, 2022
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
39 changes: 39 additions & 0 deletions docs/design-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Design doc to facilitate feature specification

## Etelemetry service objectives:
- Track software usage. Annotations:
- Process starts
- Process ends + exit status
- Heartbeats for long runtime tasks
- Software version
- Platform (bare-metal, container, etc.)
- Relevant options
- "Session" information
- "User" information
- (possibly) Elapsed time
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- (possibly) Elapsed time
- (possibly) Input dataset hash - so that we could identify open data executions (if the dataset is run unaltered).
- (possibly) Elapsed time

- (possibly) Memory utilization
- (possibly) CPU utilization
- Feedback to users:
- Notice of new versions available
- "Retired" versions (i.e., bad versions with disqualifying bugs)
- ETA (progress bar or such, using previously acquired stats from other users)

## Wishlist
- use a more generic logging tool as the backend (like prometheus)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- use a more generic logging tool as the backend (like prometheus)
- identification logic to establish user/session constructs that allow: 1) defining a "unique users" concept; 2) defining "exit points" where sessions are aggregated (i.e., 90% of the processes ended on this particular error).
- use a more generic logging tool as the backend (like prometheus)

- discard IP addresses after geo conversion
- define the message packet, the transformed message packet
- thus far we have been able to do things without caring who used the service
(even though not advertised). if messages become arbitrary, we may need
registration/auth tokens. brings up a whole different level of complexity that
i would like to avoid.
- make querying, accessing, and doing analytic plots
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to making the data acquired more usable, just need to be mindful of large server load increase

- spin up your own backend on heroku/some such

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- revisit backend DB choice (mongo/sqlite/redis)


## Message packets

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Try TCP/Restful first, resort to UDP if communication fails

### Receive

### Transformed

### Send