dd-trace/packages/dd-trace/src/plugins/util/redis.js

Datadog APM tracing client for JavaScript

'use strict'

const analyticsSampler = require('../../analytics_sampler')
const urlFilter = require('../util/urlfilter')
const tx = require('./tx')

const redis = {
  // Ensure the configuration has the correct structure and defaults.
  normalizeConfig (config) {
    const filter = urlFilter.getFilter(config)

    return Object.assign({}, config, {
      filter
    })
  },

  // Start a span for a Redis command.
  instrument (tracer, config, db, command, args) {
    const childOf = tracer.scope().active()
    const span = tracer.startSpan('redis.command', {
      childOf,
      tags: {
        'span.kind': 'client',
        'resource.name': command,
        'span.type': 'redis',
        'db.type': 'redis',
        'db.name': db || '0',
        'redis.raw_command': formatCommand(command, args)
      }
    })

    span.setTag('service.name', config.service || `${span.context()._tags['service.name']}-redis`)

    analyticsSampler.sample(span, config.measured)

    return span
  }
}

function formatCommand (command, args) {
  command = command.toUpperCase()

  if (!args || command === 'AUTH') return command

  for (let i = 0, l = args.length; i < l; i++) {
    if (typeof args[i] === 'function') continue

    command = `${command} ${formatArg(args[i])}`

    if (command.length > 1000) return trim(command, 1000)
  }

  return command
}

function formatArg (arg) {
  switch (typeof arg) {
    case 'string':
    case 'number':
      return trim(String(arg), 100)
    default:
      return '?'
  }
}

function trim (str, maxlen) {
  if (str.length > maxlen) {
    str = str.substr(0, maxlen - 3) + '...'
  }

  return str
}

module.exports = Object.assign({}, tx, redis)