Merge pull request #748 from logzio/more-trace-context-jan12

More trace context

Author: Simplychee

docs/shipping/Code/node-js.md

@@ -56,18 +56,19 @@ var logger = require('logzio-nodejs').createLogger({
 | Parameter | Description | Required/Default |
 |---|---|---|
 | token | Your Logz.io log shipping token securely directs the data to your [Logz.io account](https://app.logz.io/#/dashboard/settings/manage-tokens/log-shipping). {@include: ../../_include/log-shipping/log-shipping-token.html} | Required |
-| protocol | `http` or `https`. The value of this parameter affects the default of the `port` parameter. | `http` |
+| protocol | `http`, `https` or `udp`. The value of this parameter affects the default of the `port` parameter. | `http` |
 | host  |  {@include: ../../_include/log-shipping/listener-var.md} Replace `<<LISTENER-HOST>>` with the host [for your region](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions). The required port depends whether HTTP or HTTPS is used: HTTP = 8070, HTTPS = 8071. | `listener.logz.io` |
-| port | Destination port. The default port depends on the `protocol` parameter: `8070` (for HTTP) or `8071` (for HTTPS) | `8070` / `8071` |
+| port | Destination port. The default port depends on the `protocol` parameter. `8070` for HTTP, `8071` for HTTPS | `8070` / `8071` |
 | type | {@include: ../../_include/log-shipping/type.md} | `nodejs` |
 | sendIntervalMs  | Time to wait between retry attempts, in milliseconds. | `2000` (2 seconds) |
 | bufferSize  | Maximum number of messages the logger accumulates before sending them all as a bulk. | `100` |
 | numberOfRetries | Maximum number of retry attempts. | `3` |
 | debug | Set to `true` to print debug messages to the console.  | `false` |
-| callback | A callback function to call when the logger encounters an unrecoverable error. The function API is `function(err)`, where `err` is the Error object. | -- |
+| callback | A callback function to call when the logger encounters an unrecoverable error. On success: `callback()`. On error: `callback(error)` where `error` is the Error object. This function enables you to handle errors and successful transmissions independently. | -- |
 | timeout | Read/write/connection timeout, in milliseconds. | -- |
 | extraFields | JSON format. Adds your custom fields to each log. Format: `extraFields : { field_1: "val_1", field_2: "val_2" , ... }` | -- |
 | setUserAgent | Set to false to send logs without the user-agent field in the request header.  | `true` |
+| addOtelContext | Add `trace_id`, `span_id`, and `service_name` fields to logs when OpenTelemetry context is available. | Default: `true` |
 
 **Code example:**
 
@@ -95,6 +96,22 @@ For serverless environments, such as AWS Lambda, Azure Functions, or Google Clou
   logger.sendAndClose();
   ```
 
+
+### Add OpenTelemetry context
+
+If you're sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context. This ensures your logs include trace data, such as service name, `span_id` and `trace_id` (version >= `2.2.0`).
+
+This feature is enabled by default, To disable it, set the `AddOtelContext` param in your handler configuration to `false`, like in this example:
+
+```javascript
+var logger = require('logzio-nodejs').createLogger({
+  token: 'token',
+  type: 'no-otel-context',
+  addOtelContext: false
+});
+```
+
+
 </TabItem>
   <TabItem value="winston-logzio" label="winston-logzio">
 
@@ -170,6 +187,8 @@ For a complete list of your options, see the configuration parameters below.👇
 | timeout | Read/write/connection timeout, in milliseconds. | -- |
 | extraFields | Adds custom fields to each log in JSON format: `extraFields : { field_1: "val_1", field_2: "val_2" , ... }` | -- |
 | setUserAgent | Set to `false` to send logs without the user-agent field in the request header. Set to `false` if sending data from Firefox browser. | `true` |
+| addOtelContext | Add `trace_id`, `span_id`, and `service_name` fields to logs when OpenTelemetry context is available. | Default: `true` |
+
 
 ### Additional configuration options
 
@@ -233,6 +252,28 @@ var obj = {
 logger.log(obj);
 ```
 
+### Add opentelemetry context
+If you're sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context. This ensures your logs include trace data, such as service name, `span_id` and `trace_id` (version >= `5.2.0`). 
+
+This feature is enabled by default. To disable it, set the `AddOtelContext` param in your handler configuration to `false`, as shown in this example:
+
+```javascript
+const winston = require('winston');
+const LogzioWinstonTransport = require('winston-logzio');
+
+const logzioWinstonTransport = new LogzioWinstonTransport({
+    level: 'info',
+    name: 'winston_logzio',
+    token: '<<SHIPPING-TOKEN>>',
+    host: '<<LISTENER-HOST>>',
+    addOtelCotext: false,
+});
+
+const logger = winston.createLogger({
+    format: winston.format.simple(),
+    transports: [logzioWinstonTransport],
+});
+```
 
 </TabItem>
   <TabItem value="Typescript" label="winston-logzio Typescript">

docs/user-guide/explore/trace-view.md

@@ -28,6 +28,7 @@ Supported integrations for Trace context:
 
 * [.NET](https://docs.logz.io/docs/shipping/Code/dotnet/#add-trace-context-1)
 * [Python](https://docs.logz.io/docs/shipping/Code/Python/#trace-context)
+* [Node.js](https://docs.logz.io/docs/shipping/code/node-js/)
 
 Additional integrations will be available in future updates.