diff --git a/docs/monitoring.md b/docs/monitoring.md index b30c8e2110..e54ac5414b 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -477,7 +477,7 @@ can be identified by their `[attempt-id]`. In the API listed below, when running A list of all stages for a given application.
?status=[active|complete|pending|failed] list only stages in the given state.
?details=true lists all stages with the task data. -
?taskStatus=[RUNNING|SUCCESS|FAILED|KILLED|PENDING] lists stages only those tasks with the specified task status. Query parameter taskStatus takes effect only when details=true. +
?taskStatus=[RUNNING|SUCCESS|FAILED|KILLED|PENDING] lists only those tasks with the specified task status. Query parameter taskStatus takes effect only when details=true. This also supports multiple taskStatus such as ?details=true&taskStatus=SUCCESS&taskStatus=FAILED which will return all tasks matching any of specified task status.
?withSummaries=true lists stages with task metrics distribution and executor metrics distribution.
?quantiles=0.0,0.25,0.5,0.75,1.0 summarize the metrics with the given quantiles. Query parameter quantiles takes effect only when withSummaries=true. Default value is 0.0,0.25,0.5,0.75,1.0. @@ -487,7 +487,7 @@ can be identified by their `[attempt-id]`. In the API listed below, when running A list of all attempts for the given stage.
?details=true lists all attempts with the task data for the given stage. -
?taskStatus=[RUNNING|SUCCESS|FAILED|KILLED|PENDING] lists only those tasks with the specified task status. Query parameter taskStatus takes effect only when details=true. +
?taskStatus=[RUNNING|SUCCESS|FAILED|KILLED|PENDING] lists only those tasks with the specified task status. Query parameter taskStatus takes effect only when details=true. This also supports multiple taskStatus such as ?details=true&taskStatus=SUCCESS&taskStatus=FAILED which will return all tasks matching any of specified task status.
?withSummaries=true lists task metrics distribution and executor metrics distribution of each attempt.
?quantiles=0.0,0.25,0.5,0.75,1.0 summarize the metrics with the given quantiles. Query parameter quantiles takes effect only when withSummaries=true. Default value is 0.0,0.25,0.5,0.75,1.0.
Example: @@ -502,7 +502,7 @@ can be identified by their `[attempt-id]`. In the API listed below, when running Details for the given stage attempt.
?details=true lists all task data for the given stage attempt. -
?taskStatus=[RUNNING|SUCCESS|FAILED|KILLED|PENDING] lists only those tasks with the specified task status. Query parameter taskStatus takes effect only when details=true. +
?taskStatus=[RUNNING|SUCCESS|FAILED|KILLED|PENDING] lists only those tasks with the specified task status. Query parameter taskStatus takes effect only when details=true. This also supports multiple taskStatus such as ?details=true&taskStatus=SUCCESS&taskStatus=FAILED which will return all tasks matching any of specified task status.
?withSummaries=true lists task metrics distribution and executor metrics distribution for the given stage attempt.
?quantiles=0.0,0.25,0.5,0.75,1.0 summarize the metrics with the given quantiles. Query parameter quantiles takes effect only when withSummaries=true. Default value is 0.0,0.25,0.5,0.75,1.0.
Example: