

Enabling Correlation Logs with apictl¶

ESB API Controller (apictl) allows you to enable/disable correlation logs in MWARE ESB without a server restart. (For more information on correlation logs support in MWARE ESB, see Monitoring Correlation Logs)

Get the correlation logging components in an environment¶

Follow the instructions below to get the correlation logging components in an environment using apictl:

Make sure that the MWARE ESB 4.2.0 version is started and that the 4.2.0 version of apictl is set up.
For more information, see Download and Initialize the apictl.
Log in to the MWARE ESB in the environment by following the instructions in Login to an Environment.

Run the corresponding apictl command below to get the correlation logging components in an environment.

Get the correlation logging components in an environment.

Command
```
apictl get correlation-logging -e <environment>
```
Info

Flags:
- Required :
  --environment or -e : The environment that the command is executed on
- Optional :
  --format : pretty-print correlation logging components using Go templates
Example
```
apictl get correlation-logging -e dev 
```

Response

COMPONENT_NAME      ENABLED             PROPERTIES
http                false               -
jdbc                false               deniedThreads : MessageDeliveryTaskThreadPool, HumanTaskServer, BPELServer, CarbonDeploymentSchedulerThread
ldap                false               -
synapse             true                -
method-calls        false               -

Info

The get correlation-logging command can be executed only with a user who has super admin permissions.

Set the correlation configs for a correlation logging component in an environment¶

Follow the instructions below to set the correlation configs for a correlation logging component in an environment using apictl:

Make sure that the MWARE ESB 4.2.0 version is started and that the 4.2.0 version of apictl is set up.
For more information, see Download and Initialize the apictl.
Log in to the MWARE ESB in the environment by following the instructions in Login to an Environment.
Run the corresponding apictl command below to set the correlation configs for a correlation logging component in an environment.
1. Set the correlation configs for a correlation logging component in an environment.
  - Command
```
apictl set correlation-logging --component-name <component-name> --enable <true-or-false> --environment <environment>
```
```
apictl set correlation-logging -i <component-name> --enable <true-or-false> -e <environment>
```
```
apictl set correlation-logging --component-name <component-name> --enable <true-or-false> --denied-threads <denied-threads> --environment <environment>
```
    Info
    
    Flags:
    - Required :
      --environment or -e : The environment that the command is executed
      --component-name or -i : Component name
      --enable : Enable (can be true or false)
    - Optional :
      --denied-threads : Denied threads
    Example
```
apictl set correlation-logging --component-name http --enable true -e dev
```
```
apictl set correlation-logging --component-name jdbc --enable true --denied-threads MessageDeliveryTaskThreadPool,HumanTaskServer,BPELServer -e dev
```
  - Response
```
Correlation component http is successfully enabled.
```
Info
- Supported component name values : http, jdbc, ldap, synapse or method-calls.
- Supported values for enable: true or false.
- The set correlation-logging command can be executed only with a user who has super admin permissions.

Top