|
1 | 1 | # Pbench Server API documentation
|
2 | 2 |
|
3 |
| -The Pbench Server API provides the interface to Pbench data for use by the UI |
4 |
| -dashboard as well as any other web clients. |
| 3 | +The Pbench Server API provides a RESTful HTTPS interface to curated Pbench |
| 4 | +performance data for use by the UI dashboard as well as any other web clients. |
5 | 5 |
|
6 |
| -The Pbench Server provides a set of HTTP endpoints to manage user |
7 |
| -authentication and curated performance information, called "dataset resources" |
8 |
| -or just "datasets". A dataset represents the aggregation of server artifacts |
9 |
| -associated with the results of a performance experiment, for example the |
10 |
| -benchmarked workload and tool data collected from `pbench-fio` or from |
11 |
| -`pbench-user-benchmark`. |
| 6 | +The performance results data associated with an experiment is collectively |
| 7 | +referred to as a "dataset". The dataset resource is initially defined by the |
| 8 | +".tar.xz" tar ball uploaded to the Pbench Server. The server extracts and |
| 9 | +creates metadata describing the dataset, and (if appropriate) indexes synthetic |
| 10 | +benchmark data in Elasticsearch to support later analysis. |
12 | 11 |
|
13 |
| -The [V1 API](V1/README.md) provides a RESTful functional interface oriented |
14 |
| -around the "dataset" resource. |
| 12 | +The [V1 API](V1/README.md) provides access to the original tar ball, the |
| 13 | +original performance results file structure within the tarball, Pbench Server |
| 14 | +[metadata](metadata.md), and the Elasticsearch indexed data. |
15 | 15 |
|
16 | 16 | The Pbench Server APIs accept parameters from a variety of sources. See the
|
17 | 17 | individual API documentation for details.
|
18 | 18 | 1. Some parameters, especially "resource ids", are embedded in the URI, such as
|
19 | 19 | `/api/v1/datasets/<resource_id>`;
|
20 | 20 | 2. Some parameters are passed as query parameters, such as
|
21 |
| -`/api/v1/datasets?name:fio`; |
| 21 | +`/api/v1/datasets?filter=server.benchmark:fio`; |
22 | 22 | 3. For `PUT` and `POST` APIs, some parameters may be passed as a JSON
|
23 | 23 | (`application/json` content type) request payload, such as
|
24 | 24 | `{"metadata": {"dataset.name": "new name"}}` or as an `application/octet-stream`
|
|
0 commit comments