chore: move Job Metrics docs from Geneva#184
Conversation
jmhsieh
left a comment
jmhsieh
left a comment
There was a problem hiding this comment.
One question we need to answer.
docs/geneva/jobs/job_metrics.mdx
Outdated
| `metrics`. | ||
|
|
||
| - Job list: | ||
| - `GET /api/v1/jobs?table_name=<table>&db_uri_encoded=<...>` |
There was a problem hiding this comment.
hm.. do we expose this anywhere currently?
How would a user get to these?
There was a problem hiding this comment.
hmm yeah I guess we don't. So we'll have to:
- document the console API, probably here
- make it clear that these are calls to that API
- also say "or you can see these in the UI".
I'll do these.
There was a problem hiding this comment.
You know, I don't really want to open the can of worms of documenting the existence of the API now. Then we'd have to document it or say "it's experimental, um, don't use it" - and we'd lose flexibility to change it in the future. Plus, it doesn't really get us anything more than "look at it in the UI." So, I've just removed these API calls.
There was a problem hiding this comment.
Do we show them in the job history browser? Can we point them at it?
There was a problem hiding this comment.
Yep, in the Job Details page. That's what I did:
+ Job metrics can be found in the [Geneva Console UI](https://docs.lancedb.com/geneva/jobs/console), by clicking on a job's ID to get to the "Job details" page.
And I'm just now adding a link in that Job Details page to this doc.
3 participants
See: https://github.com/lancedb/geneva/pull/598