Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Description • 10 years ago

We created an API endpoint for Heartbeat v1. We're going to scrap that endpoint and create a new one for Heartbeat v2.

This bug covers:

1. scrapping the api/v1/hb/ endpoint and associated documentation
2. creating a new api/v2/hb/ endpoint and associated documentation

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 1 • 10 years ago

Need to document the following:

1. endpoint
2. all fields, field types, field validation and examples of field values
3. curl example of usage
4. example of flow updates

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 2 • 10 years ago

If the API successfully creates a hb record:

1. send a thing to statsd, return a 201

If the API throws a data validation error, we do the following:

1. invalid survey id? send a thing to statsd and return a 400 "bad survey_id"
2. anything else invalid? send a thing to statsd, log it in the error log and return a 400 message

We need a "health" dashboard that shows the various graphite numbers and error message histogram.

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 3 • 10 years ago

Grabbing this to work on now. Pretty sure it'll take me the rest of the week to do so making it 3 points.

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 4 • 10 years ago

I've got most of the API written, I have a bunch of tests written and I have some docs written.

Outstanding things to do:

1. a few more tests for edge cases
2. implement data validation error handling
3. statsd calls so we can track frequencies of events
4. error logging for "bad data" situations

I wrote up rough docs and send a link to Gregg Friday night. Waiting to see if that's along the lines of what he's thinking or whether we need to change things.

Probably 2/3 done at this point.

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 5 • 10 years ago

I've got it mostly written now.

The statsd data will be coarse (success/error). We can think about that later if we decide we need finer data.

This doesn't include views for things--that's covered in bug #1092300.

In a PR: https://github.com/mozilla/fjord/pull/384

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 6 • 10 years ago

Landed in https://github.com/mozilla/fjord/commit/a5e8610c4206cdf472d1ec62e20aed7a9c5b824d

Will push today with other things.

	Will Kahn-Greene [:willkg] ET needinfo? me Assignee
	Comment 7 • 10 years ago

Pushed to prod just now. Marking as FIXED.