Working on readme
This commit is contained in:
Родитель
bbab6bcd26
Коммит
130a3b903f
|
@ -30,7 +30,7 @@
|
|||
* @param properties map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty.
|
||||
* @param measurements map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty.
|
||||
*/
|
||||
stopTrackPage(name?: string, url?: string, properties?: Object, measurements?: Object);
|
||||
stopTrackPage(name?: string, url?: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; });
|
||||
|
||||
/**
|
||||
* Logs that a page or other item was viewed.
|
||||
|
@ -40,7 +40,7 @@
|
|||
* @param measurements map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty.
|
||||
* @param duration number - the number of milliseconds it took to load the page. Defaults to undefined. If set to default value, page load time is calculated internally.
|
||||
*/
|
||||
trackPageView(name?: string, url?: string, properties?: Object, measurements?: Object, duration?: number);
|
||||
trackPageView(name?: string, url?: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }, duration?: number);
|
||||
|
||||
/**
|
||||
* Start timing an extended event. Call {@link stopTrackEvent} to log the event when it ends.
|
||||
|
@ -55,7 +55,7 @@
|
|||
* @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.
|
||||
* @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.
|
||||
*/
|
||||
stopTrackEvent(name: string, properties?: Object, measurements?: Object);
|
||||
stopTrackEvent(name: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; });
|
||||
|
||||
/**
|
||||
* Log a user action or other occurrence.
|
||||
|
@ -63,7 +63,7 @@
|
|||
* @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.
|
||||
* @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.
|
||||
*/
|
||||
trackEvent(name: string, properties?: Object, measurements?: Object);
|
||||
trackEvent(name: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; });
|
||||
|
||||
/**
|
||||
* Log an AJAX request
|
||||
|
@ -77,13 +77,13 @@
|
|||
*/
|
||||
trackAjax(id: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number, method?: string);
|
||||
|
||||
/**
|
||||
* Log an exception you have caught.
|
||||
* @param exception An Error from a catch clause, or the string error message.
|
||||
* @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.
|
||||
* @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.
|
||||
*/
|
||||
trackException(exception: Error, handledAt?: string, properties?: Object, measurements?: Object);
|
||||
/**
|
||||
* Log an exception you have caught.
|
||||
* @param exception An Error from a catch clause, or the string error message.
|
||||
* @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.
|
||||
* @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.
|
||||
*/
|
||||
trackException(exception: Error, handledAt?: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; });
|
||||
|
||||
/**
|
||||
* Log a numeric value that is not associated with a specific event. Typically used to send regular reports of performance indicators.
|
||||
|
@ -95,14 +95,14 @@
|
|||
* @param min The smallest measurement in the sample. Defaults to the average.
|
||||
* @param max The largest measurement in the sample. Defaults to the average.
|
||||
*/
|
||||
trackMetric(name: string, average: number, sampleCount?: number, min?: number, max?: number, properties?: Object);
|
||||
trackMetric(name: string, average: number, sampleCount?: number, min?: number, max?: number, properties?: { [name: string]: string; });
|
||||
|
||||
/**
|
||||
* Log a diagnostic message.
|
||||
* @param message A message string
|
||||
* @param properties map[string, string] - additional data used to filter traces in the portal. Defaults to empty.
|
||||
*/
|
||||
trackTrace(message: string, properties?: Object);
|
||||
trackTrace(message: string, properties?: { [name: string]: string; });
|
||||
|
||||
|
||||
/**
|
||||
|
@ -111,13 +111,13 @@
|
|||
flush();
|
||||
|
||||
|
||||
/**
|
||||
* Sets the autheticated user id and the account id in this session.
|
||||
* User auth id and account id should be of type string. They should not contain commas, semi-colons, equal signs, spaces, or vertical-bars.
|
||||
*
|
||||
* @param authenticatedUserId {string} - The authenticated user id. A unique and persistent string that represents each authenticated user in the service.
|
||||
* @param accountId {string} - An optional string to represent the account associated with the authenticated user.
|
||||
*/
|
||||
/**
|
||||
* Sets the autheticated user id and the account id in this session.
|
||||
* User auth id and account id should be of type string. They should not contain commas, semi-colons, equal signs, spaces, or vertical-bars.
|
||||
*
|
||||
* @param authenticatedUserId {string} - The authenticated user id. A unique and persistent string that represents each authenticated user in the service.
|
||||
* @param accountId {string} - An optional string to represent the account associated with the authenticated user.
|
||||
*/
|
||||
setAuthenticatedUserContext(authenticatedUserId: string, accountId?: string);
|
||||
|
||||
|
||||
|
|
|
@ -0,0 +1,10 @@
|
|||
import {AppInsights, initialize as initializeAppInsights} from "AppInsightsModule"
|
||||
initializeAppInsights({ instrumentationKey: "f2c1b11a-e3ec-4d3a-b96b-xxxxxxxx" });
|
||||
AppInsights.trackPageView(
|
||||
"FirstPage",
|
||||
null,
|
||||
{ prop1: "prop1", prop2: "prop2" },
|
||||
{ measurement1: 1 },
|
||||
123);
|
||||
|
||||
AppInsights.trackEvent("TestEvent", { prop1: "prop1", prop2: "prop2" }, { measurement1: 1 });
|
10
README.md
10
README.md
|
@ -9,7 +9,15 @@ If you don't have an Azure subscription and would like to try Application Insigh
|
|||
|
||||
To use this SDK, you'll need a subscription to [Microsoft Azure](https://azure.com). (There's a free package.)
|
||||
|
||||
In the [Azure Preview Portal](https://portal.azure.com), open an Application Insights resource.
|
||||
In the [Azure Preview Portal](https://portal.azure.com), create new or open an existing Application Insights resource.
|
||||
|
||||
### Initialize for MVC application
|
||||
|
||||
### Import as a module
|
||||
* Obtain instrumentation key from your Application Insights resource
|
||||
* Install appinsights-js with npm
|
||||
`npm install applicationinsights-js`
|
||||
|
||||
|
||||
Get "code to monitor my web pages" from the Quick Start page, and insert it in the head of your web pages.
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
"name": "applicationinsights-js",
|
||||
"version": "0.22.14",
|
||||
"description": "Microsoft Application Insights JavaScript SDK",
|
||||
"main": "dist/ai.0.js",
|
||||
"main": "JavaScriptSDK/AppInsightsModule",
|
||||
"keywords": [
|
||||
"browser performance monitoring",
|
||||
"script errors",
|
||||
|
|
Загрузка…
Ссылка в новой задаче