mozilla / telemetry-next-node

Node.js module for accessing Mozilla Unified Telemetry aggregates via Telemetry.js v2.

Telemetry.js v2 for Node

The telemetry-next-node module loads telemetry.js from https://telemetry.mozilla.org/v2/telemetry.js and make the functions available in node.js, so that telemetry dashboard aggregates can be analyzed server-side.

Warning, this module downloads and loads Javascript code from https://telemetry.mozilla.org/v2/telemetry.js via HTTPS. If security is very important, run this inside an isolated environment such as a Docker container.

For long-running applications, it is recommended that the module be re-initialized every so often in order to obtain new data and account for any aggregate API changes. This can be done by calling Telemetry.init() again - see below for details.

Usage

A simple usage example:

var Telemetry = require('telemetry-next-node');

// Initialize library
Telemetry.init(function() {
  var version = Telemetry.getVersions()[0]; // Get the first available version

  // Optain a mapping from filter names to possible values of those filters
  var parts = version.split("/");
  Telemetry.getFilterOptions(parts[0], parts[1], function(filters) {
    console.log("Measures available:");
    filters.metric.forEach(function(measure) {
      console.log(measure);
    });
  });
});

Note that until Telemetry.init(callback) executes, this module will not have other methods than Telemetry.init. In the browser, these methods will be available, but they will throw an exception if Telemetry.init has not completed yet. This is a minor difference, but it may show up if testing for the existence of specific methods in the library.

Reloading

Just like telemetry.js in the browser, you can reload version information by calling Telemetry.init() again. This also causes the code to be reloaded from https://telemetry.mozilla.org/v2/telemetry.js. Reloading is necessary in order to get updated information, such as aggregates published after the module has been loaded.

Reloading is necessary for long-running applications to obtain fresh data. An application that does not reload may behave erratically if changes are made to the backend.

License

The telemetry-next-node library is released on the MPL license - see LICENSE for details.

telemetry-next-node's Issues

Request timeout leads to empty response object

When making repeated requests, one sometimes runs into timeouts. However, since the patched getJSON code in this library checks res.status in the case of timeouts res is null the library crashes in that case.

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Wiki changes

FYI: The following changes were made to this repository's wiki:

• defacing spam has been removed

• the wiki has been disabled, as it was not used

These were made as the result of a recent automated defacement of publically writeable wikis.

index.js:9 Uncaught TypeError: request.get(...).buffer is not a function

CC @chutten

I'm trying to vendor telemetry-wrapper.js.
I make reference to it:

import '../vendor/telemetry-wrapper';
then I call it:
TelemetryWrapper.go(plot, node);

Inside of telemetry-wrapper.js I add the following line:

import Telemetry from 'telemetry-next-node';

Unfortunately this approach throws the following:

index.js:9 Uncaught TypeError: request.get(...).buffer is not a function
    at Object.exports.init (index.js:9)
    at Object.window.TelemetryWrapper.go (telemetry-wrapper.js:28)

Line 9 is the following:
https://github.com/mozilla/telemetry-next-node/blob/master/index.js#L9

exports.init = function(cb) {
  request
    .get('https://telemetry.mozilla.org/v2/telemetry.js')
    .buffer()
.end(function(err, res) {