Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhsdigital/ndr_browser_timings
Rails engine to performs client-side instrumentation and feeds back to the application.
https://github.com/nhsdigital/ndr_browser_timings
browser instrumentation javascript rails
Last synced: about 2 months ago
JSON representation
Rails engine to performs client-side instrumentation and feeds back to the application.
- Host: GitHub
- URL: https://github.com/nhsdigital/ndr_browser_timings
- Owner: NHSDigital
- License: mit
- Created: 2020-04-27T16:00:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T14:37:57.000Z (3 months ago)
- Last Synced: 2024-11-22T15:34:07.147Z (3 months ago)
- Topics: browser, instrumentation, javascript, rails
- Language: Ruby
- Homepage:
- Size: 92.8 KB
- Stars: 0
- Watchers: 14
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# NdrBrowserTimings [](https://github.com/NHSDigital/ndr_browser_timings/actions?query=workflow%3Atest) [](https://rubygems.org/gems/ndr_browser_timings)
This Rails Engine adds JavaScript that allows for the collection of users' browser timing information.
## Usage
Once installed (see below), timing information will be submitted from browsers
via AJAX, back to the mounted engine, and passed to any configured recorders.
Recorders can be any callable object, and can be configured like so:
```ruby
NdrBrowserTimings.recorders << ->(timing) { MyService.notify(timing) }
```
This gem bundles some recorders:
```ruby
# Send info to the Rails log:
require 'ndr_browser_timings/recorders/logger'
NdrBrowserTimings.recorders << NdrBrowserTimings::Recorders::Logger.new
# Send info to prometheus:
require 'ndr_browser_timings/recorders/ndr_stats'
NdrStats.configure(...)
NdrBrowserTimings.recorders << NdrBrowserTimings::Recorders::NdrStats.new
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ndr_browser_timings'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install ndr_browser_timings
```
Inject the client library into pages you want timings submitted from:
```javascript
//=require 'ndr_browser_timings/ndr_browser_timings'
```
and the `` tag to provide configuration to the client library:
```ruby
<%= ndr_browser_timings_meta_tag %>
```
By default, all requests will be instrumented. You can alternatively elect to only
sample a fraction of requests, to reduce data collected:
```ruby
<%= ndr_browser_timings_meta_tag(sample_rate: 0.1) %>
```
This is an isolated engine, so you'll need to configure with an authentication check:
```ruby
# Allow all requests through (careful!):
NdrBrowserTimings.check_current_user_authentication = ->(request) { true }
```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the NdrBrowserTimings project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the `CODE_OF_CONDUCT.md`.
## TODO:
* javascript fallback