Giter Club home page Giter Club logo

applicationinsights-js-mezzurite's Introduction

npm version

Introduction

This is the Application Insights Plugin for the Mezzurite Timing tool. This plugin enables Mezzurite timings to be sent to your Application Insights log storage.

Below is an example of the data sent into Applicaiton Insights Mezzurite Application Insights Workbook

Getting Started

This logger is designed to forward Mezzurite Metrics to Application Insights for monitoring and analytics.

Demo App

Azure-Samples/appinsights-guestbook is a React application implementing the Application Insights Web SDK with Mezzurite. It can be used as a guide for your implementation.

Prerequisites

Install and Configure the Applicaiton Insights JS SDK 1.0.20 or Greater

Follow the Applicaiton Insights JS SDK Getting Started documentation to enable Application Insights.

Install and Instrument your Applicaiton with Mezzurite

Follow the Mezzurite Framework Documentation for your specific framework to install and instrument your applicaiton.

Setup

Install the Extension

Install the Application Insights Mezzurite Extension via NPM:

https://www.npmjs.com/package/@microsoft/applicationinsights-mezzurite

Include the Extension in your Application

For EMS:

Inside the file which contains the added application insights sku:

import {withMezzuriteRouter} from '@microsoft/mezzurite-react';
    const mzLog = new MezzuritePlugIn();
    const iKey = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"; // Replace this with your instrumenationKey for Application Insights. 
    const ai = new ApplicationInsights({config: {extensions: [mzLog], instrumentationKey: iKey, maxBatchInterval: 100, disableFetchTracking: false}});
        ai.loadAppInsights();

For UMD:

    <script type="text/javascript" src="<PathToNpmPackage>/browser/applicationInsight.mezzurite.umd.js"></script>
    <!-- the snippet below assumes that JS SDK script has already loaded -->
    <script type="text/javascript" src="/pathToAIJSSDK.js"></script>   
    <script type="text/javascript">   
        var mzLog = new ApplicationInsightsMezzurite.MezzuritePlugIn();

        var snippet = {   
                config: {   
                    extensions: [mzLog],
                    instrumentationKey: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"   
                }   
            };   
        var init = new Microsoft.ApplicationInsights.Initialization(snippet);   
        var appInsights = init.loadAppInsights();   

Build

 npm run build

Test

In the Test folder of the repo there is a Test.html page. Build the project, then open test.html. This html uses the logger from the build and sends fake data to the subscription.

You can validate the output either in Azure or by opening dev tools and looking at the network trace. The data will be in the track calls.

Mezzurite Ecosystem

Projects
ApplicationInsights-JS-Mezzurite Application insights extension of Mezzurite
Mezzurite Base SDK for Mezzurite with Angular, AngularJS and React integration
Mezzurite DevTools See Mezzurite metrics being captured with a browser extension
VSCode Mezzurite Check which components and modules are instrumented within VS Code

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

applicationinsights-js-mezzurite's People

Contributors

baresj avatar brrusino avatar jerryblake avatar jpiyali avatar kawwong avatar microsoftopensource avatar msftgits avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

applicationinsights-js-mezzurite's Issues

Typescript Error when running npm run build out of the box

Steps followed:

  1. Cloned from master branch
  2. run npm install
  3. run npm run build

The build fails with the following error:

> @microsoft/applicationinsights-mezzurite@1.0.9 build C:\Users\caabreut.REDMOND\Desktop\ApplicationInsights-JS-Mezzurite
> npm run clean && tsc --p tsconfig.json && rollup -c && typedoc --out Doc


> @microsoft/applicationinsights-mezzurite@1.0.9 clean C:\Users\caabreut.REDMOND\Desktop\ApplicationInsights-JS-Mezzurite
> shx rm -rf _bundles dist dist-esm

src/Mezzurite.ts:114:7 - error TS2322: Type '{ name: string; url: string; }' is not assignable to type 'IPageViewPerformanceTelemetry'.
  Object literal may only specify known properties, and 'url' does not exist in type 'IPageViewPerformanceTelemetry'.

114       url:  url
          ~~~~~~~~~


Found 1 error.

npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! @microsoft/applicationinsights-mezzurite@1.0.9 build: `npm run clean && tsc --p tsconfig.json && rollup -c && typedoc --out Doc`
npm ERR! Exit status 2
npm ERR!
npm ERR! Failed at the @microsoft/applicationinsights-mezzurite@1.0.9 build script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\caabreut.REDMOND\AppData\Roaming\npm-cache\_logs\2019-05-29T17_41_27_124Z-debug.log

I am unsure if this was caused by the revving of the AI SDK version or some other previous commit. Nonetheless, a broken build out of the box is not acceptable and we should have CICD in place to have caught it.

Set up boilerplate for the new implementation in a new branch: 'next'

In order to create the base upon which the 2.x implementation will be built, we need a basic set of boilerplate configs and repository setup that has worked for us previously and continues to do so today. We will do so in a new branch to not disturb the default branch's appearance until we are ready to switch over.

The boilerplate will include things like .gitignore, Jest configuration for unit testing, linting via ESLint, etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.