@datadog/browser-logs
Datadog browser logs library.
Last updated 4 days ago by datadog .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @datadog/browser-logs 
SYNC missed versions from official npm registry.

logs

Datadog browser logs library.

Browser support

Setup

NPM

import { datadogLogs } from '@datadog/browser-logs'
datadogLogs.init({
  clientToken: 'XXX',
  site: 'datadoghq.com',
  forwardErrorsToLogs: true,
  sampleRate: 100
})

Bundle

<script src = 'https://www.datadoghq-browser-agent.com/datadog-logs.js'>
<script>
  window.DD_LOGS.init({
    clientToken: 'XXX',
    site: 'datadoghq.com',
    forwardErrorsToLogs: true,
    sampleRate: 100
  });
</script>

Public API

What we call Context is a map {key: value} that will be added to the message context.

  • Init must be called before other methods.

    • Configurable options:

      • isCollectingError: when truthy, we'll automatically forward console.error logs, uncaught exceptions and network errors.
      • sampleRate: percentage of sessions to track. Only tracked sessions send logs.
      • site: The site of the Datadog intake to send SDK data to (default: 'datadoghq.com', set to 'datadoghq.eu' to send data to the EU site)
      • silentMultipleInit: prevent logging errors while having multiple Init
      • service: name of the corresponding service
      • env: environment of the service
      • version: version of the service
    • Options that must have matching configuration when using rum SDK:

      • trackSessionAcrossSubdomains: preserve session across subdomains of the same site (default: false)
      • useSecureSessionCookie: use a secure session cookie. This will disable session tracking on insecure (non-HTTPS) connections. (default: false)
      • useCrossSiteSessionCookie: use a secure cross-site session cookie. This will allow the Logs SDK to run when the site is loaded from another one (ex: via an iframe). Implies useSecureSessionCookie. (default: false)
    init(configuration: {
        clientToken: string,
        site?: string,
        isCollectingError?: boolean,
        sampleRate?: number,
        silentMultipleInit?: boolean,
        service?: string,
        env?: string,
        version?: string,
        trackSessionAcrossSubdomains?: boolean,
        useSecureSessionCookie?: boolean,
        useCrossSiteSessionCookie?: boolean,
    })
    
  • Default logger

    logger.debug | info | warn | error (message: string, messageContext = Context)`
    logger.log (message: string, messageContext: Context, status? = 'debug' | 'info' | 'warn' | 'error')
    logger.setLevel (level?: 'debug' | 'info' | 'warn' | 'error')
    logger.setHandler (handler?: 'http' | 'console' | 'silent')
    logger.addContext (key: string, value: any)  # add one key-value to the logger context
    logger.removeContext (key: string)  # remove one key from the logger context
    logger.setContext (context: Context)  # entirely replace the logger context
    
  • Custom loggers

    Custom loggers have the same API than the default logger

    createLogger (name: string, conf?: {
        level?: 'debug' | 'info' | 'warn' | 'error'
        handler?: 'http' | 'console' | 'silent'
        context?: Context
    })  # create a new logger
    getLogger (name: string)  # retrieve a previously created logger
    
  • Modify the global context for all loggers

    addLoggerGlobalContext (key: string, value: any)  # add one key-value to the default context
    removeLoggerGlobalContext (key: string)  # remove one key of the default context
    setLoggerGlobalContext (context: Context)  # entirely replace the default context
    

TypeScript support

Types are compatible with TypeScript >= 3.0. For earlier version, you can import js sources and use global variable to avoid any compilation issue:

import '@datadog/browser-logs/bundle/datadog-logs';

window.DD_LOGS.init({
  clientToken: 'XXX',
  site: 'datadoghq.com',
  forwardErrorsToLogs: true,
  sampleRate: 100
});

Current Tags

  • 1.21.0                                ...           latest (4 days ago)

63 Versions

  • 1.21.0                                ...           4 days ago
  • 1.20.1                                ...           10 days ago
  • 1.20.0                                ...           13 days ago
  • 1.19.0                                ...           19 days ago
  • 1.18.1                                ...           21 days ago
  • 1.18.0                                ...           25 days ago
  • 1.17.0                                ...           a month ago
  • 1.16.0                                ...           a month ago
  • 1.15.3                                ...           a month ago
  • 1.15.2                                ...           a month ago
  • 1.15.1                                ...           a month ago
  • 1.15.0                                ...           a month ago
  • 1.14.1                                ...           2 months ago
  • 1.14.0                                ...           2 months ago
  • 1.13.0                                ...           2 months ago
  • 1.12.10                                ...           2 months ago
  • 1.12.9                                ...           2 months ago
  • 1.12.8                                ...           3 months ago
  • 1.12.7                                ...           3 months ago
  • 1.12.6                                ...           3 months ago
  • 1.12.5                                ...           3 months ago
  • 1.12.4                                ...           4 months ago
  • 1.12.3                                ...           4 months ago
  • 1.12.2                                ...           4 months ago
  • 1.12.1                                ...           4 months ago
  • 1.12.0                                ...           4 months ago
  • 1.11.6                                ...           4 months ago
  • 1.11.5                                ...           4 months ago
  • 1.11.4                                ...           5 months ago
  • 1.11.3                                ...           5 months ago
  • 1.11.2                                ...           5 months ago
  • 1.11.1                                ...           5 months ago
  • 1.10.0                                ...           5 months ago
  • 1.9.4                                ...           6 months ago
  • 1.9.3                                ...           6 months ago
  • 1.9.2                                ...           6 months ago
  • 1.9.1                                ...           6 months ago
  • 1.9.0                                ...           6 months ago
  • 1.8.1                                ...           6 months ago
  • 1.7.5                                ...           6 months ago
  • 1.7.4                                ...           6 months ago
  • 1.7.3                                ...           6 months ago
  • 1.7.1                                ...           7 months ago
  • 1.7.0                                ...           7 months ago
  • 1.6.3                                ...           7 months ago
  • 1.5.0                                ...           7 months ago
  • 1.4.2                                ...           7 months ago
  • 1.4.1                                ...           7 months ago
  • 1.4.0                                ...           8 months ago
  • 1.3.3                                ...           8 months ago
  • 1.3.2                                ...           8 months ago
  • 1.3.1                                ...           8 months ago
  • 1.3.0                                ...           8 months ago
  • 1.2.11                                ...           8 months ago
  • 1.2.10                                ...           8 months ago
  • 1.2.9                                ...           8 months ago
  • 1.2.8                                ...           8 months ago
  • 1.2.7                                ...           8 months ago
  • 1.2.6                                ...           9 months ago
  • 1.2.5                                ...           9 months ago
  • 1.2.4                                ...           9 months ago
  • 1.2.3                                ...           9 months ago
  • 1.2.2 [deprecated]           ...           9 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 99
Last Day 0
Last Week 12
Last Month 102
Dependencies (2)
Dev Dependencies (2)

Copyright 2014 - 2017 © taobao.org |