insight
Advanced tools
Package description
The 'insight' npm package is used for tracking and reporting anonymous usage metrics for your Node.js applications. It helps developers understand how their tools are being used by collecting data such as command usage, version information, and other relevant metrics.
Tracking Usage
This feature allows you to track usage events in your application. The code sample demonstrates how to initialize the Insight instance, ask for user permission, and track an event.
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
trackingCode: 'UA-000000-01',
pkg
});
// Ask for permission the first time
if (insight.optOut === undefined) {
insight.askPermission();
}
// Track an event
insight.track('event', 'category', 'action', 'label', 'value');Opt-in/Opt-out Management
This feature allows you to manage user consent for tracking. The code sample shows how to check if the user has opted out of tracking.
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
trackingCode: 'UA-000000-01',
pkg
});
// Check if the user has opted out
if (insight.optOut) {
console.log('User has opted out of tracking');
} else {
console.log('User has opted in to tracking');
}Custom Event Tracking
This feature allows you to track custom events specific to your application. The code sample demonstrates how to track a custom event with specific parameters.
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
trackingCode: 'UA-000000-01',
pkg
});
// Track a custom event
insight.track('customEvent', 'customCategory', 'customAction', 'customLabel', 'customValue');The 'analytics-node' package is a client for Segment's analytics service. It allows you to track events and send them to various analytics services. Compared to 'insight', 'analytics-node' offers more integrations and is part of a larger analytics ecosystem.
The 'universal-analytics' package is a Node.js module for Google's Universal Analytics. It allows you to send data to Google Analytics from your server-side applications. Unlike 'insight', which is more focused on anonymous usage tracking, 'universal-analytics' is specifically designed for Google Analytics.
The 'mixpanel' package is a client for Mixpanel's analytics service. It provides robust event tracking and user analytics capabilities. Compared to 'insight', 'mixpanel' offers more advanced features like user segmentation and funnel analysis.
Readme
Understand how your tool is being used by anonymously reporting usage metrics to Google Analytics or Yandex.Metrica
$ npm install insight
Currently, Insight should be used with GA set up as web tracking due to use of URLs. Future plans include refactoring to work with GA set up for app-based tracking and the Measurement Protocol.
For debugging, Insight can track OS version, Node.js version, and version of the app that implements Insight. Please set up custom dimensions per below screenshot. This is a temporary solution until Insight is refactored into app-based tracking.
Insight cares deeply about the security of your user's data and strives to be fully transparent with what it tracks. All data is sent via HTTPS secure connections. Insight provides API to offer an easy way for users to opt-out at any time.
Below is what Insight is capable of tracking. Individual implementation can choose to not track some items.
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
// Google Analytics tracking code
trackingCode: 'UA-XXXXXXXX-X',
pkg
});
// Ask for permission the first time
if (insight.optOut === undefined) {
insight.askPermission();
}
insight.track('foo', 'bar');
// Recorded in Analytics as `/foo/bar`
insight.trackEvent({
category: 'eventCategory',
action: 'eventAction',
label: 'eventLabel',
value: 'eventValue'
});
// Recorded in Analytics behavior/events section
const Insight = require('insight');
const pkg = require('./package.json');
const insight = new Insight({
// Yandex.Metrica counter id
trackingCode: 'XXXXXXXXX'
trackingProvider: 'yandex',
pkg
});
// Ask for permission the first time
if (insight.optOut === undefined) {
insight.askPermission();
}
insight.track('foo', 'bar');
// Recorded in Yandex.Metrica as `http://<package-name>.insight/foo/bar`
Required
Type: string
Your Google Analytics trackingCode or Yandex.Metrica counter id.
Type: string
Default: google
Values: google yandex
Tracking provider to use.
Required
Type: string
Type: string
Default: 'undefined'
Type: Object
Default: An instance of configstore
If you want to use your own configuration mechanism instead of the default configstore-based one, you can provide an object that has to implement two synchronous methods:
get(key)set(key, value)Accepts keywords which ends up as a path in Analytics.
.track('init', 'backbone') becomes /init/backbone
Accepts event category, action, label and value as described in the GA event tracking documentation via the options object. Note: Does not work with Yandex.Metrica.
.trackEvent({
category: 'download',
action: 'image',
label: 'logo-image'
});
Required
Type: string
Event category: Typically the object that was interacted with (e.g. 'Video').
Required
Type: string
Event action: The type of interaction (e.g. 'play').
Type: string
Event label: Useful for categorizing events (e.g. 'Fall Campaign').
Type: integer
Event value: A numeric value associated with the event (e.g. 42).
Asks the user permission to opt-in to tracking and sets the optOut property in config. You can also choose to set optOut property in config manually.
Optionally supply your own message and callback. If message is null, default message will be used. The callback will be called with the arguments error and optIn when the prompt is done and is useful for when you want to continue the execution while the prompt is running.
Returns a boolean whether the user has opted out of tracking. Should preferably only be set by a user action, eg. a prompt.
BSD-2-Clause © Google
FAQs
Understand how your tool is being used by anonymously reporting usage metrics to Google Analytics or Yandex.Metrica
The npm package insight receives a total of 97,754 weekly downloads. As such, insight popularity was classified as popular.
We found that insight demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In June 2023, Google sold all Google Domains accounts to Squarespace but more than a dozen customers have had their domains hijacked in the last week due to weak security defaults and migration issues.
![Massive Automated Spam Campaign Abuses GitHub to Flood npm Registry with Thousands of Garbage Tea[.]xyz Packages](https://cdn.sanity.io/images/cgdhsj6q/production/a74d1072ff2bb5cb96a404be58a649931ced2ba5-1024x1024.webp?w=400&fit=max&auto=format)
Security News
In a reprisal of their previous Tea[.]xyz spam campaign, a new wave of thousands of garbage packages are hitting npm, to artificially inflate the number of dependents for spammers' projects.
Security News
The maintainer of the node-ip project restored the GitHub repo after disputing an exaggerated CVE rating, highlighting the impact of bogus CVEs on open source projects.