diff options
Diffstat (limited to 'third_party/rust/glean/README.md')
-rw-r--r-- | third_party/rust/glean/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/third_party/rust/glean/README.md b/third_party/rust/glean/README.md new file mode 100644 index 0000000000..d99b0e3563 --- /dev/null +++ b/third_party/rust/glean/README.md @@ -0,0 +1,44 @@ +# Glean + +The `Glean SDK` is a modern approach for a Telemetry library and is part of the [Glean project](https://docs.telemetry.mozilla.org/concepts/glean/glean.html). + +## `glean` + +This library provides a Rust language bindings on top of `glean-core`, targeted to Rust consumers. + +## Documentation + +All documentation is available online: + +* [The Glean SDK Book][book] +* [API documentation][apidocs] + +[book]: https://mozilla.github.io/glean/ +[apidocs]: https://mozilla.github.io/glean/docs/glean/index.html + +## Example + +```rust,no_run +use glean::{Configuration, Error, metrics::*}; + +let cfg = Configuration { + data_path: "/tmp/data".into(), + application_id: "org.mozilla.glean_core.example".into(), + upload_enabled: true, + max_events: None, + delay_ping_lifetime_io: false, +}; +glean::initialize(cfg)?; + +let prototype_ping = PingType::new("prototype", true, true, vec![]); + +glean::register_ping_type(&prototype_ping); + +prototype_ping.submit(None); +``` + +## License + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/ |