Skip to content

Commit

Permalink
Describe the rate limiting in user facing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
brizental committed Jun 22, 2020
1 parent bfbf5ff commit babf1c3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/user/pings/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ See [Using the Experiments API](../experiments-api.md) on how to record experime
## Ping submission

The pings that the Glean SDK generates are submitted to the Mozilla servers at specific paths, in order to provide additional metadata without the need to unpack the ping payload.

> **Note**: To keep resource usage in check, ping submission is rate limited for a maximum of 10 pings every 60 seconds.
A typical submission URL looks like

`"<server-address>/submit/<application-id>/<doc-type>/<glean-schema-version>/<document-id>"`
Expand All @@ -102,6 +105,7 @@ A pre-defined set of headers is additionally sent along with the submitted ping:
| `X-Client-Type` | `Glean` | Custom header to support handling of Glean pings in the legacy pipeline |
| `X-Client-Version` | e.g. `0.40.0` | The Glean SDK version, sent as a custom header to support handling of Glean pings in the legacy pipeline |


## Defining foreground and background state

These docs refer to application 'foreground' and 'background' state in several places.
Expand Down

0 comments on commit babf1c3

Please sign in to comment.