---
schema_version: "1"
id: 5bef7888437faed0957fb1edd5512f389edc40df4208573c702eb48400e5f83f
title: Tracing Module 1.0 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/tracing-module/1.0/tracing-module-reference.md
canonical_url: https://docs.mulesoft.com/tracing-module/1.0/tracing-module-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: d156848b4523ebd5b944ba1daca098ab6502c347590cdb52bf0eb9e7d4e81edc
description: MuleSoft Documentation Site
release: "1.0"
latest: false
---
---
product: Tracing Module
version: 1.0
---

# Tracing Module 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Tracing module enables you to enhance your logs by adding, removing, and clearing variables from the
logging context for a given Mule event. It also enables you to modify the correlation ID during flow
execution.

## Configurations

---

### Default Configuration

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

## Operations

### Clear Logging Variables

`<clear-logging-variables>`

Clears all the logging variables from the event logging context. This operation does not remove the
correlation ID nor the current event processor because those variables are managed by Mule runtime
engine.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Display name for the operation</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Remove Logging Variables

`<remove-logging-variable>`

Removes a variable from the event logging context.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Display name for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Variable name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable to remove.</p></div></div></td><td><div><div><p>x</p></div></div></td><td><div></div></td></tr></tbody></table>

### Set Logging Variables

`<set-logging-variable>`

Sets a new logging variable and its value. The new variable is present in the next operation
execution for the event.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Display name for the operation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Variable name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable to log.</p></div></div></td><td><div><div><p>x</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Value to assign to the variable. Accepts DataWeave expressions.</p></div></div></td><td><div><div><p>x</p></div></div></td><td><div></div></td></tr></tbody></table>

## Scopes

### With CorrelationID

`<with-correlation-id>`

Scope that creates a process where the inner chain modifies the current correlation ID in the event
flow. After the process finishes its execution, the correlation ID returns to the previous ID.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Display name for the scope</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Correlation id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Set a custom correlation ID.</p></div></div></td><td><div><div><p>x</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)