fe-supervisor

fe-supervisor (The frontend monitor project)

Quick Start

Several options to get up and running:

• Clone the repo: git clone [e-mail]:BobbyLH/fe-supervisor.git
• Install with npm: npm install fe-supervisor -S
• Install with Yarn: yarn add fe-supervisor

<script src=`${pathTo}/dist/fe-supervisor.sdk.${version}.js` ></script>
<script>
    console.log($sv.getTiming())
</script> 

import sv from 'fe-supervisor'
 
console.log(sv.getMemory())

API

Global NameSpace

$sv

Methods

getPerformanceData(config)

Get the all performance data.

import sv from 'fe-supervisor'
 
sv.getPerformanceData().then(data => console.log(data))

interface IconfigSources {
  [propName: string]: string[];
}
 
interface config {
  apiRatio?: number;
  sourceRatio?: number;
  apis?: string[] | string;
  sources?: IconfigSources | string[] | string;
  timeout?: number; // timeout threshold(millisecond) - default 2000
  whitelist?: Iwhitelist;
  paintTiming?: boolean;
}

getMemory()

Get memory consumption.

getTiming()

Get performance timing.

getSource(config)

Get source timing.

import sv from 'fe-supervisor'
 
sv.getSource().then(data => console.log(data))

interface IconfigSources {
  [propName: string]: string[];
}
 
interface config {
  apiRatio?: number;
  sourceRatio?: number;
  apis?: string[] | string;
  sources?: IconfigSources | string[] | string;
  timeout?: number; // timeout threshold(millisecond) - default 2000
  whitelist?: Iwhitelist;
  paintTiming?: boolean;
}

mark(tag)

Marking a tag in the code.

getExecTiming()

Get tagged code execution timing.

import sv from 'fe-supervisor'
 
sv.getExecTiming().then(data => console.log(data))

clearPerformance()

Clear performance data.

observeSource(target, callback, option?: IobserveSourceOption)

get source timing information by refer dom.

import sv from 'fe-supervisor'
 
const sec = document.querySelect('section')
sv.observeSource(sec, function (source) {
  console.log('source', source)
}, {
  sourceType: ['script', 'img', 'link']
})

interface IobserveSourceOption {
  sourceType?: string | string[];
  timeout?: number;
  whitelist?: Iwhitelist;
}

getEnvInfo()

Get browser environment information.

getError(errType)

Get errors information.

type errType = 'js' | 'api' | 'source'

setError(error)

Set error.

interface error {
  type: ExceptionType;
  sourceType?: string;
  url: string;
  [propName: string]: any;
}

makeTrackInfo(type, info)

Making a track infomation.

observeError(target, callback?, observeDom?)

obersevation appoint target's children error.

import sv from 'fe-supervisor'
import React from 'react'
 
 
 
export default class Detail extends React.PureComponent{
  constructor (props) {
    super(props)
    this.pool = React.createRef()
  }
  addImg () {
    // observer DOM
    $sv.observeError(pool, function (errObj) {
      console.log('errObj', errObj)
    })
    // api request
    this.setState({
      Imgs: data
    })
  }
 
  getError () {
    const errObj = sv.getError('source')
    console.log(errObj)
  }
 
  render () {
    const { Imgs = null } = this.state
    return (
      <div ref={this.pool}>
        <button onClick={this.addImg.bind(this)}>Load Image</button>
        { Imgs }
        <button onClick={this.getError.bind(this)}>Get Error Message</button>
      </div>
    )
  }
}

type target = HTMLElement
type observeDom = string | string[]

License

Copyright (c) 2019-2019 Bobby.li

Released under the MIT License