Configuring Traces for Node.js SDK

Trace Configuration of Automatically Supported Integrations
Disabling the integrations
To disable an integration, you can use the thundra_agent_trace_integrations_disable environment variable. Set this environment variable's value to a string that includes a comma (,) in order to separate integration names.
For example, to disable redis and the http integration, you need to use the following environment variable and value: thundra_agent_trace_integrations_disable: redis,http
​
Configuring AWS SDK Trace 
Masking SQS Messages
You can mask sent SQS messages on the client’s side, which calls AWS SDK by setting the following environment variable:
1
thundra_agent_trace_integrations_aws_sqs_message_mask: true
Copied!
Masking SNS Messages
You can mask sent SNS messages on the client’s side, which calls AWS SDK by setting the following environment variable:
1
thundra_agent_trace_integrations_aws_sns_message_mask: true
Copied!
Masking DynamoDB Statements
You can mask sent DynamoDB statements on the client’s side, which calls AWS SDK by setting the following environment variable:
1
thundra_agent_trace_integrations_aws_dynamodb_statement_mask: true
Copied!
Masking Lambda Payload
You can mask Lambda invocation payloads on the client’s side, which calls AWS SDK by setting the following environment variable:
1
thundra_agent_trace_integrations_aws_lambda_payload_mask: true
Copied!
Masking API Gateway Request Body
You can mask a request body on the client’s side by setting the following environment variable:
1
thundra_agent_trace_integrations_http_body_mask: true
Copied!
Masking Athena Statements
You can mask Athena statements on the client’s side, which calls AWS SDK by setting the following environment variable:
1
thundra_agent_trace_integrations_aws_athena_statement_mask: true
Copied!
Disabling AWS SDK Trace
Tracing AWS SDK calls is enabled by default, but can also be disabled through configuration if needed. You just need to add the aws value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here: thundra_agent_trace_integrations_disable: aws
AWS Step Functions
You can see distributed traces of step functions by setting the following environment variable:
1
thundra_agent_lambda_aws_stepfunctions: true
Copied!
This variable enables step function trace link injection to the response. This configuration is disabled by default.
AWS AppSync
You can see distributed traces of AppSync by setting the following environment variable:
1
thundra_agent_lambda_aws_appsync: true
Copied!
This variable enables AppSync trace link injection to the response. This configuration is disabled by default.
Configuring Redis Trace
Masking Redis
You can mask Redis calls by setting the following environment variable:
1
thundra_agent_trace_integrations_redis_command_mask: true
Copied!
Disabling Redis Trace
Tracing Redis calls is enabled by default, but can also be disabled  through configuration if needed. You just need to add the redis value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: redis 
Configuring IORedis Trace
Masking IORedis
You can mask IORedis calls by setting the following environment variable:
1
thundra_agent_trace_integrations_redis_command_mask: true
Copied!
Disabling IORedis Trace
Tracing IORedis calls is enabled by default, but can also be disabled  through configuration if needed. You just need to add the ioredis value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: ioredis 
Configuring HTTP/HTTPS Trace
Masking HTTP Request Body
You can mask the http request body on the client’s side by setting the following environment variable:
1
thundra_agent_trace_integrations_http_body_mask: true
Copied!
Disabling HTTP/HTTPS Trace
Tracing HTTP/HTTPS calls is enabled by default, but can also be disabled through configuration if needed. You just need to add the http value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: http 
Disabling 4XX/5XX Errors
Tracing 4XX/5XX errors on http/https response is enabled by default, but also be disabled through configuration by adding following environment variables.
1
thundra_agent_trace_integrations_http_error_on4xx_disable: true #for 4XX errors
2
thundra_agent_trace_integrations_http_error_on5xx_disable: true #for 5XX errors
Copied!
Configuring MySQL/MySQL2 Trace
Masking MySQL/MySQL2 Queries 
You can mask MySQL/MySQL2 queries on the client’s side by setting the following environment variable:
1
thundra_agent_trace_integrations_rdb_statement_mask: true
Copied!
Disabling MySQL/MySQL2 Trace
Tracing MySQL/MySQL2 calls is enabled by default, but can also be disabled through configuration if needed. You just need to add the mysql or mysql2 value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: mysql,mysql2 
Configuring PostgreSQL Trace
Masking PostgreSQL Queries 
You can mask PostgreSQL queries on the client’s side by setting the following environment variable:
1
thundra_agent_trace_integrations_rdb_statement_mask: true
Copied!
Disabling PostgreSQL Trace
Tracing PostgreSQL calls is enabled by default, but can also be disabled through configuration if needed. You just need to add the pg value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: pg 
Configuring Elasticsearch Trace
Masking Elasticsearch Body 
You can mask the Elasticsearch body on the client’s side by setting the following environment variable:
1
thundra_agent_trace_integrations_elasticsearch_body_mask: true
Copied!
Disabling Elasticsearch Trace
Tracing Elasticsearch calls is enabled by default, but can also be disabled through configuration if needed. You just need to add the es value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: es 
Configuring MongoDB Trace
Masking MongoDB Commands 
You can mask MongoDB commands on the client’s side by setting the following environment variable:
1
thundra_agent_trace_integrations_mongodb_command_mask: true
Copied!
Disabling MongoDB Trace
Tracing MongoDB calls is enabled by default, but can also be disabled through configuration if needed. You just need to add the mongodb value to the array string for the thundra_agent_trace_integrations_disable environment variable as shown here:
thundra_agent_trace_integrations_disable: mongodb 
Configuring Trace Plugin
Masking Request
Requests can be masked by setting the maskRequest function into traceConfig.
1
const thundra = require("@thundra/core");
2
const config = {
3
  traceConfig: {
4
    maskRequest: (event) => {
5
      // Mask the event
6
      event.password = "???";
7
      return event;
8
    }
9
  }
10
};
11
exports.handler = thundra(config)((event, context, callback) => {
12
  callback(null, {
13
    msg: 'hello world'
14
  });
15
});
Copied!
Masking Response
Responses can be masked by setting the maskResponse function into traceConfig.
1
const thundra = require("@thundra/core");
2
const config = {
3
  traceConfig: {
4
    maskResponse: (response) => {
5
      // Mask the response
6
      response.msg = "???";
7
      return response;
8
    }
9
  }
10
};
11
exports.handler = thundra(config)((event, context, callback) => {
12
  callback(null, {
13
    msg: 'hello world'
14
  });
15
});
Copied!
​
Disabling Request/Response Tracing for Lambda
Requests and responses are traced by default, but can be disabled with environment variable configuration.
To disable tracing requests, set the thundra_agent_lambda_trace_request_skip environment variable to true.
Configuration via Environment Variable
1
thundra_agent_lambda_trace_request_skip: true
Copied!
To disable tracing response set the thundra_agent_lambda_trace_response_skipenvironment variable to true
Configuration via Environment Variable
1
thundra_agent_lambda_trace_response_skip: true
Copied!
Disabling trace plugin programmatically on agent initialization
Disabling trace plugin programatically
1
const thundra = require("@thundra/core")({ 
2
  traceConfig: {
3
    enabled: false,
4
  },
5
});
Copied!
Disabling trace plugin using environment variables
Configuration of Trace Plugin via Environment Variables
1
thundra_agent_trace_disable: true
Copied!
Configuring Google Pub / Sub
Publish
1
const { PubSub } = require('@google-cloud/pubsub');
2
​
3
const projectId = 'your_google_cloud_project_id';
4
const topicName = 'your_google_cloud_pubsub_topic';
5
​
6
const pubsub = new PubSub({ projectId });
7
​
8
/* 
9
* if topic allready exists 
10
* const topic = await pubsub.topic(topicName)
11
**/
12
const topic = await pubsub.createTopic(topicName);
13
​
14
const date = new Date().toString();
15
const dataBuffer = Buffer.from(JSON.stringify({date}));
16
​
17
const result = await topic.publishMessage({ data: dataBuffer });
Copied!
Subscription
Asynchronous Pull
1
const thundra = require("@thundra/core");
2
thundra.init();
3
​
4
const { PubSub, Subscription } = require('@google-cloud/pubsub');
5
​
6
const projectId = 'your_google_cloud_project_id';
7
const topicName = 'your_google_cloud_pubsub_topic';
8
const subscriptionName = 'your_google_cloud_pubsup_subscription_name';
9
​
10
const pubsub = new PubSub({ projectId });
11
​
12
(async() => {
13
    
14
    /* 
15
    * if subscription allready exists 
16
    * const subscription = pubsub.subscription(subscriptionName);
17
    **/
18
    const [subscription] = await pubsub.topic(topicName).createSubscription(subscriptionName);
19
    
20
    const messageHandler = message => {
21
      try {
22
        ...
23
        message.ack();
24
      } catch (err) {
25
        ...
26
        message.nack();
27
      }
28
    };
29
    
30
    subscription.on(`message`, messageHandler);
31
})().catch(error => console.log(error));
Copied!
Synchronous Pull
1
const { v1 } = require('@google-cloud/pubsub');
2
​
3
const subClient = new v1.SubscriberClient();
4
​
5
const projectId = 'your_google_cloud_project_id';
6
const subscriptionName = 'your_google_cloud_pubsup_subscription_name';
7
​
8
const formattedSubscription = subClient.subscriptionPath(
9
  projectId,
10
  subscriptionName
11
);
12
​
13
const request = {
14
  subscription: formattedSubscription,
15
  maxMessages: 10,
16
};
17
​
18
...
19
​
20
const result = await subClient.pull(request);
21
const [response] = result;
22
​
23
const ackIds = [];
24
for (const message of response.receivedMessages) {
25
  ...
26
  ackIds.push(message.ackId);
27
}
28
​
29
if (ackIds.length !== 0) {
30
  const ackRequest = {
31
    subscription: formattedSubscription,
32
    ackIds: ackIds,
33
  };
34
​
35
  await subClient.acknowledge(ackRequest);
36
}
37
...

Copied!

Configuring Logs for Node.js

Tagging in Node.js SDK

Last modified 4mo ago

Copy link

Contents

Trace Configuration of Automatically Supported Integrations

Disabling the integrations

Configuring AWS SDK Trace

AWS Step Functions

AWS AppSync

Configuring Redis Trace

Configuring IORedis Trace

Configuring HTTP/HTTPS Trace

Configuring MySQL/MySQL2 Trace

Configuring PostgreSQL Trace

Configuring Elasticsearch Trace

Configuring MongoDB Trace

Configuring Trace Plugin

Configuring Google Pub / Sub