Skip to content

TASK-144791: Updated documentation for DELETE /stats/summary #812

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
dkoerichbird wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TASK-144791: Updated documentation for DELETE /stats/summary #812

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
6 changes: 4 additions & 2 deletions content/momentum/4/console-commands/summary-reset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ summary reset — reset summary statistics
statistics cleared.
```

The **summary reset** command resets the statistics counters of the running instance. It is useful for determining the current performance levels of a long-running Momentum instance, particularly with respect to metrics that are averages, such as Delivery Rate and Reception Rate.
The **summary reset** command resets the statistics counters of the running instance. It is useful for determining the current performance levels of a long-running Momentum instance, particularly with respect to metrics that are averages, such as Delivery Rate and Reception Rate.

**NOTE:** Since Momentum 5.2, reset of statistics is available through the HTTP API as well. See the [summary](/momentum/4/http-api-stats/summary) documentation for details.

<a name="idp10810640"></a>
## See Also

[binding summary](/momentum/4/console-commands/binding-summary), [summary](/momentum/4/console-commands/summary)
[binding summary](/momentum/4/console-commands/binding-summary), [summary](/momentum/4/console-commands/summary)
25 changes: 21 additions & 4 deletions content/momentum/4/http-api-stats/summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
---
lastUpdated: "11/05/2024"
lastUpdated: "12/31/2025"
title: "Summary"
description: "stats summary show global metrics Perhaps the most common API command stats summary will produce global metrics such as queue sizes message counts and throughput rates since startup or the last reset of statistics"
---

<a name="http_api_stats.summary"></a>
## Name

`/stats/summary` — show global metrics
`/stats/summary` — global metrics

## Synopsis

`GET /stats/summary`

`DELETE /stats/summary`

## Description

Perhaps the most common API command, `/stats/summary` will produce global metrics such as queue sizes, message counts and throughput rates since startup or the last reset of statistics.
### Gather Global Metrics

Perhaps the most common API command, `GET /stats/summary` will produce global metrics such as queue sizes, message counts and throughput rates since startup or the last reset of statistics.

The data is formatted as a JSON object and you might want to use the `curl` command to do the request (e.g. `curl -sS localhost:2081/stats/summary`).

Expand Down Expand Up @@ -323,10 +327,23 @@ The number of seconds that Momentum has been running continuously.

</dl>

### Reset Statistics

You can reset the statistics used to generate this report by issuing a `DELETE` request to the same URL: `DELETE /stats/summary`. This will reset all the cumulative counters to zero and the time-based metrics will be calculated from that point forward. The output of a successful reset operation is as follows:

```json
{
"message": "statistics cleared"
}
```

## See Also

[summary](/momentum/4/console-commands/summary),
[summary reset](/momentum/4/console-commands/summary-reset)

## Note

This command was first implemented in Momentum 4.4.1.
`GET /stats/summary` was first implemented in Momentum 4.4.1.

`DELETE /stats/summary` was first implemented in Momentum 5.2.
Loading