Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/user/reference/general/initializing.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Below are listed the configuration options available on most SDKs.
- `appBuild`: A build identifier e.g. the build identifier generated by a CI system (e.g. "1234/A"). If not present, `app_build` will be reported as "Unknown" on all pings [`client_info`](../../user/pings/index.html#the-client_info-section) section.
- `appDisplayVersion`: The user visible version string for the application running Glean. If not present, `app_display_version` will be reported as "Unknown" on all pings [`client_info`](../../user/pings/index.html#the-client_info-section) section.
- `serverEndpoint`: The server pings are sent to. Defaults to `https://incoming.telemetry.mozilla.org`.
- `maxEvents`: The maximum number of events the Glean storage will hold on to before submitting the 'events' ping. Defaults to 500. Refer to the [`events` ping documentation](../../user/pings/events.md) for more information on its scheduling.
- `maxEvents`: The maximum number of events the Glean storage will hold on to before submitting the 'events' ping. Defaults to 1 for Glean.js, 500 for all other SDKs. Refer to the [`events` ping documentation](../../user/pings/events.md) for more information on its scheduling.
- `httpUploader`: A custom HTTP uploader instance, that will overwrite Glean's provided uploader. Useful
for users that wish to use specific uploader implementations. See [Custom Uploaders](#custom-uploaders)
for more information on how and when the use this feature.
Expand Down
3 changes: 2 additions & 1 deletion docs/user/reference/metrics/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@ Each extra key contains additional metadata:

## Limits

* When 500 events are queued on the client an "events" ping is immediately sent.
* In Glean.js the default value for `maxEvents` is 1. In all other SDKs it is 500.
* Once the `maxEvents` threshold is reached on the client an "events" ping is immediately sent.
* The `extra_keys` allows for a maximum of 15 keys.
* The keys in the `extra_keys` list must be in dotted snake case, with a maximum length of 40 bytes, when encoded as UTF-8.
* The values in the `extras` object have a maximum length of 500 bytes when serialized and encoded as UTF-8.
Expand Down
2 changes: 1 addition & 1 deletion docs/user/user/pings/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `events` ping is automatically submitted under the following circumstances:

1. If there are any recorded events to send when the application becomes inactive (on mobile, this means going to [background](sent-by-glean.md#defining-foreground-and-background-state)).

2. When the queue of events exceeds `Glean.configuration.maxEvents` (default 500). This configuration
2. When the queue of events exceeds `Glean.configuration.maxEvents` (default 1 for Glean.js, 500 for all other SDKs). This configuration
option can be changed at [initialization](../../reference/general/initializing.md).

3. If there are any unsent events found on disk when starting the application. _(This results in this ping never containing the [`glean.restarted`](./custom.md#the-gleanrestarted-event) event.)_
Expand Down