Skip to content

Module for applicationinsights with common default settings

Notifications You must be signed in to change notification settings

KTH/kth-node-appinsights

Repository files navigation

@kth/appinsights

A wrapper for the applicationinsights package.

This is intended for a standard use-case only. If your app needs more options, please use the core package instead.

Usage

Applicationinsights works by injecting code that captures telemetry from the application. To get full tracking, this package should be initialized as soon as possible in the code.

import { KthAppinsights } from '@kth/appinsights'

KthAppinsights.init({ name: 'app-name' })

Options

type appinsightOptions = {
  name?: string // Optional. Name of the application
  samplingPercentage?: number // Optional. Reduce the amount of telemetry collected
}

Features

Name and Instance name.

The if name is passed in the options, it will be used to set "Cloud role name" and "Cloud role instance".

User agent on requests

If a request has the user-agent header set, it will be saved in the custom property user_agent.

Unpack Bunyan messages

Bynyan messages (used by @kth/log) will be desctructured, and only the "msg" field kept, as all other information is duplicated on native data fields.

Example:
{ name: "my-app", level: 30, msg: "the important part" } will be reduced to just "the important part".

Telemetry Sampling

Used to reduce the amount of telemetry collected, primary used to reduce cost. Enable with option samplingPercentage. Default is 100% = everything is collected.

Track operations for Agenda jobs

This is not intended to be used on all agenda jobs. Only use ut when there is an actuall need.
A helper that groups all events in a agenda-jobb in a tracable operation.

Example:

const { AppinsightsUtils } = require('@kth/appinsights')

agenda.define('operation_name', AppinsightsUtils.agendaRequestWrapper('operation_name', jobFunction))

About

Module for applicationinsights with common default settings

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •