Skip to content

CONFIGURATION.md

Latest commit

 

History

History
119 lines (93 loc) · 3.61 KB

CONFIGURATION.md

File metadata and controls

119 lines (93 loc) · 3.61 KB

Configuration

Tracing

The Tracing feature is enabled by default. To disable it, pass the following option to the initialization function.

require('instana-nodejs-sensor')({
  tracing: {
    enabled: false
  }
});

Disabling Automatic Tracing

Automatic tracing is enabled by default. To disable it, pass the following option to the initialization function.

require('instana-nodejs-sensor')({
  tracing: {
    disableAutomaticTracing: true
  }
});

Capturing Stack Traces

By default, the sensor captures the last ten call sites for every captured exit span. This value can be increased and decreased as necessary. Use a value of 0 to disable stack trace capturing.

require('instana-nodejs-sensor')({
  tracing: {
    enabled: true,
    stackTraceLength: 10
  }
});

OpenTracing Service Naming

Services are a central concept within Instana. Spans and traces are associated to services. To name services when using OpenTracing, you can configure the serviceName property.

require('instana-nodejs-sensor')({
  serviceName: 'shop'
});

Logging

Bunyan Parent Logger

This sensor is using the bunyan logging module. By default, the Node.js sensor uses a standard bunyan logger with an INFO log level. You can a define parent logger for all the loggers created by this module in the following way:

require('instana-nodejs-sensor')({
  logger: A_BUNYAN_LOGGER
});

Log Level Configuration

The Node.js sensor will now create children of this logger with the same log level and target streams. If you only want to change the default log level, you can configure it via:

require('instana-nodejs-sensor')({
  level: 'debug'
});

Agent Communication

Agent Host

The sensor tries to communicate with the Instana agent via IP 127.0.0.1 and as a fallback via the host's default gateway. Should the agent not be available under either of these IPs, e.g. due to iptables or other networking tricks, you can use the agentHost option to use a custom IP.

require('instana-nodejs-sensor')({
  agentHost: '::1' // use IPv6 to contact via localhost
});

Or leverage an environment variable:

require('instana-nodejs-sensor')({
  agentHost: process.env.INSTANA_AGENT_IP
});

Agent Port

The sensor tries to communicate with the Instana Agent via port 42699. Should the port have been changed, you can use the agentPort option to change the port.

require('instana-nodejs-sensor')({
  agentPort: 42699
});

Agent Name

This sensor communicates with the Instana Agent via HTTP. While doing so, the Node.js sensor validates the Instana Agent's Server response header. Should you have changed the Server name, use the agentName option to adjust the sensor's validation rules.

require('instana-nodejs-sensor')({
  agentName: 'Instana Agent'
});