Skip to content

[FLINK-39617] [runtime] Add batch aggregated subtask metrics endpoints #29012

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.

Sign up for GitHub

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

Open
Jackeyzhe wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[FLINK-39617] [runtime] Add batch aggregated subtask metrics endpoints #29012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4988,6 +4988,117 @@
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/subtasks/metrics/names</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides batch access to aggregated subtask metric names.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>regex</code> (optional): Comma-separated list of Java regular expressions to filter metric names by full match.</li>
<li><code>vertices</code> (mandatory): Comma-separated list of 32-character hexadecimal strings to select specific job vertices.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Request</summary>
<pre><code>{}</code></pre>
</label>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
}</code></pre>
</label>
</td>
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/subtasks/metrics/values</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Provides batch access to aggregated subtask metric values.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">Query parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
<li><code>agg</code> (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg, skew".</li>
<li><code>vertices</code> (mandatory): Comma-separated list of 32-character hexadecimal strings to select specific job vertices.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Request</summary>
<pre><code>{}</code></pre>
</label>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Response</summary>
<pre><code>{
"type" : "any"
}</code></pre>
</label>
</td>
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
Expand Down
77 changes: 77 additions & 0 deletions docs/static/generated/rest_v1_dispatcher.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,81 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/LogUrlResponse"
/jobs/{jobid}/vertices/subtasks/metrics/names:
get:
description: Provides batch access to aggregated subtask metric names.
operationId: getAggregatedSubtaskMetricsNames
parameters:
- name: jobid
in: path
description: 32-character hexadecimal string value that identifies a job.
required: true
schema:
$ref: "#/components/schemas/JobID"
- name: vertices
in: query
description: Comma-separated list of 32-character hexadecimal strings to select
specific job vertices.
required: true
style: form
schema:
$ref: "#/components/schemas/JobVertexID"
- name: regex
in: query
description: Comma-separated list of Java regular expressions to filter metric
names by full match.
required: false
style: form
schema:
type: string
responses:
"200":
description: The request was successful.
content:
application/json:
schema:
$ref: "#/components/schemas/AggregatedSubtaskMetricsBatchResponseBody"
/jobs/{jobid}/vertices/subtasks/metrics/values:
get:
description: Provides batch access to aggregated subtask metric values.
operationId: getAggregatedSubtaskMetricsValues
parameters:
- name: jobid
in: path
description: 32-character hexadecimal string value that identifies a job.
required: true
schema:
$ref: "#/components/schemas/JobID"
- name: vertices
in: query
description: Comma-separated list of 32-character hexadecimal strings to select
specific job vertices.
required: true
style: form
schema:
$ref: "#/components/schemas/JobVertexID"
- name: get
in: query
description: Comma-separated list of string values to select specific metrics.
required: false
style: form
schema:
type: string
- name: agg
in: query
description: "Comma-separated list of aggregation modes which should be calculated.\
\ Available aggregations are: \"min, max, sum, avg, skew\"."
required: false
style: form
schema:
$ref: "#/components/schemas/AggregationMode"
responses:
"200":
description: The request was successful.
content:
application/json:
schema:
$ref: "#/components/schemas/AggregatedSubtaskMetricsBatchResponseBody"
/jobs/{jobid}/vertices/{vertexid}:
get:
description: "Returns details for a task, with a summary for each of its subtasks."
Expand Down Expand Up @@ -1891,6 +1966,8 @@ components:
schemas:
AggregatedMetricsResponseBody:
type: object
AggregatedSubtaskMetricsBatchResponseBody:
type: object
AggregatedTaskDetailsInfo:
type: object
properties:
Expand Down
55 changes: 55 additions & 0 deletions flink-runtime-web/src/test/resources/rest_api_v1.snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3846,6 +3846,61 @@
}
}
}
}, {
"url" : "/jobs/:jobid/vertices/subtasks/metrics/names",
"method" : "GET",
"status-code" : "200 OK",
"file-upload" : false,
"path-parameters" : {
"pathParameters" : [ {
"key" : "jobid"
} ]
},
"query-parameters" : {
"queryParameters" : [ {
"key" : "vertices",
"mandatory" : true
}, {
"key" : "regex",
"mandatory" : false
} ]
},
"request" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:EmptyRequestBody"
},
"response" : {
"type" : "any"
}
}, {
"url" : "/jobs/:jobid/vertices/subtasks/metrics/values",
"method" : "GET",
"status-code" : "200 OK",
"file-upload" : false,
"path-parameters" : {
"pathParameters" : [ {
"key" : "jobid"
} ]
},
"query-parameters" : {
"queryParameters" : [ {
"key" : "vertices",
"mandatory" : true
}, {
"key" : "get",
"mandatory" : false
}, {
"key" : "agg",
"mandatory" : false
} ]
},
"request" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:EmptyRequestBody"
},
"response" : {
"type" : "any"
}
}, {
"url" : "/jobs/:jobid/vertices/:vertexid",
"method" : "GET",
Expand Down
Loading