doc: introduces a REST use-cases section #471
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chungg
previously requested changes
Nov 8, 2017
doc/source/rest.j2
Outdated
| Use-cases examples | ||
| ================== | ||
|
|
||
| 1. I want the top N instances for project_id "BD3A1E52-1C62-44CB-BF04-660BD88CD74D" that consume the most cpu last hour. |
doc/source/rest.j2
Outdated
| @@ -931,6 +931,22 @@ reporting values such as the number of new |measures| to process for each | |||
|
|
|||
| {{ scenarios['get-status']['doc'] }} | |||
|
|
|||
| Use-cases examples | |||
doc/source/rest.j2
Outdated
|
|
||
| To do so, I will use the :ref:`Dynamic aggregates API <aggregates>`. I will use | ||
| |start|, |stop|, |granularity| and |groupby| parameters. The entire query will | ||
| looke like: |
There was a problem hiding this comment.
i imagine everything will probably go through aggregates endpoint so maybe drop this intro.
doc/source/rest.j2
Outdated
|
|
||
| {{ scenarios['use-case1-top-cpuutil-per-instances']['doc'] }} | ||
|
|
||
| I have ensured that |stop| - |start| = |granularity| to get only one point per |
There was a problem hiding this comment.
The following is configured so that |stop| - |start| = |granularity| will get only one point per instance.
doc/source/rest.j2
Outdated
| instances. | ||
|
|
||
| This will give all informations we need to order by cpu.util timeseries and | ||
| pick only the N we are interrested in. |
There was a problem hiding this comment.
This will give all information needed to order by cpu.util timeseries which can be filtered down to N results.
|
Tests FAILURE for HEAD 6ca14b4
|
sileht
force-pushed
the
sileht/doc-use-cases
branch
from
6ca14b4 to
6ac38f8
Compare
|
Pull-request updated, HEAD is now 6ac38f8 |
|
Tests FAILURE for HEAD 6ac38f8
|
|
Tests SUCCESS for HEAD 6ac38f8
|
chungg
reviewed
Nov 9, 2017
doc/source/rest.j2
Outdated
| only one point per instance. | ||
|
|
||
| This will give all information needed to order by cpu.util timeseries which can | ||
| be filtered down to N results.. |
There was a problem hiding this comment.
s/.././
we can maybe move the example REST below the text but it's not important.
sileht
force-pushed
the
sileht/doc-use-cases
branch
from
6ac38f8 to
7d5755d
Compare
|
Pull-request updated, HEAD is now 7d5755d |
jd
previously requested changes
Nov 9, 2017
doc/source/rest.j2
Outdated
| @@ -838,6 +838,17 @@ Operations between metrics can also be done, such as: | |||
|
|
|||
| {{ scenarios['get-aggregates-between-metrics']['doc'] }} | |||
|
|
|||
| List top N instances for that consume the most cpu last hour | |||
There was a problem hiding this comment.
List the top N resources that consume the most CPU during last hour
doc/source/rest.j2
Outdated
| The following is configured so that `stop` - `start` = `granularity` will get | ||
| only one point per instance. | ||
|
|
||
| This will give all information needed to order by cpu.util timeseries which can |
There was a problem hiding this comment.
with or without 'the' works. i guess with 'the' is more correct.
|
Tests SUCCESS for HEAD 7d5755d
|
We should list all REST API use-case that people is asking for, to not get issue opened for new feature when it's already possible to get the data. It's not always clear what API call I need to do to get all informations I need for a use-cases. This change starts a new section and add one example. Related gnocchixyz#465.
sileht
force-pushed
the
sileht/doc-use-cases
branch
from
7d5755d to
380e355
Compare
|
Pull-request updated, HEAD is now 380e355 |
|
Tests SUCCESS for HEAD 380e355
|
chungg
approved these changes
Nov 10, 2017
jd
approved these changes
Nov 10, 2017
ghost
merged commit
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We should list all REST API use-case that people is asking for, to
not get issue opened for new feature when it's already possible to get
the data.
It's not always clear what API call I need to do to get all informations
I need for a use-cases.
This change starts a new section and add one example.
Related #465.