-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
Document HTTP API v1. #135
Conversation
The one thing I want to change before merging is the location of this document in the menu structure. I haven't found a good place for it yet. Maybe rename one of the sections to make it fit in better? Like the Visualization section? |
|
||
The current stable HTTP API is reachable under `/api/v1` on a Prometheus | ||
server. Any non-breaking additions will be added under that endpoint. There are | ||
no minor versions of the API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was more for the design doc. I don't think we have to document what we not have.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the last sentence.
65078b2
to
3c6580a
Compare
I've updated the "Query language" menu section to just "Querying" now, so that the "HTTP API" section fits in better. Also, linked to it from the beginning of the "Basics" section. It's still not perfect, as the API has one endpoint so far that isn't strictly "querying" (the series deletion), but probably the best we can do for without major restructuring of the menus. |
Yes, that will work. 👍 |
Before merging this, we need to fix the vector output format to have the same timestamp/value representation as the matrix one. I already changed this PR to reflect the anticipated change now. |
[ | ||
{ | ||
"metric": { "<label_name>": "<label_value>", ... }, | ||
"timestamp": <unix_time>, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah right, done.
@fabxc Hmm, now it would be most consistent to also bundle up the timestamp with the value for |
Yes, I've thought about that - would be 👍 on this. Even though it requires more back porting for the legacy API. |
|
Updated to match prometheus/prometheus#872. Should be good to merge now. |
Yes 👍 |
No description provided.