Otp

Module

Syntax

Code Block

language	js

require('e2e-transaction-logger');

Semantics

The module itself is an object of type TransactionLogger.

Examples

Code Block

language	js

var transactionLogger = require('e2e-transaction-logger');
var trx = transactionLogger.startTransaction('MyTransaction');

You can use directly the module to trace transactions

Anchor
TransactionLogger
TransactionLogger
TransactionLogger

constructor

Syntax

Code Block

language	none

TransactionLogger.constructor(logPath)

Semantics Creates an object of type TransactionLogger.

Arguments logPath The path where the log files will be written.

Examples

Code Block

language	js

var TransactionLogger = require('e2e-transaction-logger').TransactionLogger;
var myTransactionLogger = new TransactionLogger('my/custom/log/path');

...

startTransaction

Syntax

Code Block

language	none

TransactionLogger.startTransaction(name)

Semantics Traces the start of a transaction and return a Transaction object.

Arguments name The name of the transaction.

Examples

Code Block

language	js

var trx = transactionLogger.startTransaction('MyTransaction');

processLogger

Syntax

Code Block

language	js

require('e2e-transaction-logger').processLogger;

Semantics

An object of type ProcessLogger.

Examples

Code Block

language	js

var transactionLogger = require('e2e-transaction-logger');
transactionLogger.processLogger.processStart('ProcessName', 'processId', 'StartEventName');

Anchor
ProcessLogger
ProcessLogger
ProcessLogger

constructor

Syntax

Code Block

language	none

ProcessLogger.constructor(logPath)

Semantics Creates an object of type ProcessLogger.

Arguments logPath The path where the log files will be written.

Examples

Code Block

language	js

var ProcessLogger = require('e2e-transaction-logger').ProcessLogger;
var myProcessLogger = new ProcessLogger('my/custom/log/path');

...

processStart

Syntax

Code Block

language	none

ProcessLogger.processStart(processName, processId, eventName)

Semantics

Traces the start of a process.

Arguments

processName

The name of the process.

processId

The process id.

eventName

The start event name.

Examples

Code Block

language	js

processLogger.processStart('ProcessName', 'processId', 'StartEventName');

processEnd

Syntax

Code Block

language	none

ProcessLogger.processEnd(processName, processId, eventName)

Semantics

Traces the end of a process.

Arguments

processName

The name of the process.

processId

The process id.

eventName

The end event name.

Examples

Code Block

language	js

processLogger.processEnd('ProcessName', 'processId', 'EndEventName');

processStateStart

Syntax

Code Block

language	none

ProcessLogger.processStateStart(processName, processId, stateName)

Semantics

Traces the start of a state.

Arguments

processName

The name of the process.

processId

The process id.

stateName

The state name.

Examples

Code Block

language	js

processLogger.processStateStart('ProcessName', 'processId', 'StateName');

processStateEnd

Syntax

Code Block

language	none

ProcessLogger.processStateStart(processName, processId, stateName)

Semantics

Traces the end of a state.

Arguments

processName

The name of the process.

processId

The process id.

stateName

The state name.

Examples

Code Block

language	js

processLogger.processStateEnd('ProcessName', 'processId', 'StateName');

processChoice

Syntax

Code Block

language	none

ProcessLogger.processChoice(processName, processId, gateway, choice)

Semantics

Traces a choice.

Arguments

processName

The name of the process.

processId

The process id.

gateway

The gateway name.

choice

The choice name.

Examples

Code Block

language	js

processLogger.processChoice('ProcessName', 'processId', 'Gateway', 'Choice');

processEvent

Syntax

Code Block

language	none

ProcessLogger.processEvent(processName, processId, eventName)

Semantics

Traces an event.

Arguments

processName

The name of the process.

processId

The process id.

eventName

The eventname.

Examples

Code Block

language	js

processLogger.processStateStart('ProcessName', 'processId', 'EventName');

processValueString

Syntax

Code Block

language	none

ProcessLogger.processValueString(processName, processId, key, value)

Semantics

Traces a value of a String type.

Arguments

processName

The name of the process.

processId

The process id.

key

The key.

value

The value

Examples

Code Block

language	js

processLogger.processValueString('ProcessName', 'processId', 'Key', 'MyValue');

processValueFloat

Syntax

Code Block

language	none

ProcessLogger.processValueFloat(processName, processId, key, value)

Semantics

Traces a value of a Float type.

Arguments

processName

The name of the process.

processId

The process id.

key

The key.

value

The value

Examples

Code Block

language	js

processLogger.processValueString('ProcessName', 'processId', 'Key', 123.456);

processValueDateTime

Syntax

Code Block

language	none

ProcessLogger.processValueDateTime(processName, processId, key, value)

Semantics

Traces a value of a Date type.

Arguments

processName

The name of the process.

processId

The process id.

key

The key.

value

The value

Examples

Code Block

language	js

processLogger.processValueString('ProcessName', 'processId', 'Key', new Date());

Anchor
Transaction
Transaction
Transaction

A Transaction object is returned by the startTransaction method of a TransactionLogger. It is then used to trace what happens inside the transaction using startIO or any ProcessLogger method. Using transactions to trace processes instead of a ProcessLogger directly allows you to correlate the process steps and IOs of these transactions.

end

Syntax

Code Block

language	none

Transaction.end(state)

Semantics

Traces the end of a transaction.

Arguments

state

The state of the transaction. It can be true or 'OK' for a success, false or 'ERROR' for a failed. Default: 'OK'

Examples

Code Block

language	js

var trx = transactionLogger.startTransaction('MyTransaction');

// do some things

trx.end();

startIO

Syntax

Code Block

language	none

Transaction.startIO(name, domain, system)

Semantics

Trace the start of an IO call and return an IO object.

Arguments

name

The name of the IO call

domain

The domain of the IO call

system

The system of the IO call

Examples

Code Block

language	js

var io = trx.startIO('SELECT Users','SQL','oracle/XE');

Anchor
IO
IO
IO

An IO object is returned by the startIO method of a Transaction. It is then used to trace the end of the IO call.

end

Syntax

Code Block

language	none

IO.end(state)

Semantics

Traces the end of a IO call.

Arguments

state

The state of the IO call. It can be true or 'OK' for a success, false or 'ERROR' for a failed. Default: 'OK'

Examples

Code Block

language	js

var io = trx.startIO('Read','FILE','HelloWorld.txt');

fs.readFile(__dirname + '/resource/HelloWorld.html',function(err, data){
    io.end();
});

transactionLoggerMiddleware

A function that returns a middle ware which can be used with express. It will automatically start a transaction when a request arrives and end it when the response is sent. The Transaction object will be available in the request object as trx.

Arguments

options

object

```
logPath
```

The path where the log files will be written.

```
name
```

The name that should be given to the transactions. Can be a function taking the request and response as parameter and returning the name. By default the name will be the URL of the request.

Examples

Code Block

language	js

var express = require('express');
var fs = require('fs');
var transactionLoggerMiddleware = require('e2e-transaction-logger').transactionLoggerMiddleware;

var app = express();

app.use(transactionLoggerMiddleware());

app.get('/hello.html', function(req, res){
    var io = req.trx.startIO('Read','FILE','HelloWorld.html');

    fs.readFile(__dirname + '/resource/HelloWorld.html',function(err, data){
        if(err){
            io.end('ERROR');    
            res.send(503, err); // the status code define if the transaction failed or succeed. >= 400 it failed
            return;
        }

        io.end();
        res.set('Content-Type', 'text/html');
        res.send(data);
    });
});

Panel

title	On this Page:

Table of Contents

Page tree

Versions Compared

Old Version 1

New Version Current

Key

The

Module

Anchor
TransactionLogger
TransactionLogger
TransactionLogger

constructor

startTransaction

processLogger

Anchor
ProcessLogger
ProcessLogger
ProcessLogger

constructor

processStart

processEnd

processStateStart

processStateEnd

processChoice

processEvent

processValueString

processValueFloat

processValueDateTime

Anchor
Transaction
Transaction
Transaction

end

startIO

Anchor
IO
IO
IO

end

transactionLoggerMiddleware

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

The

Module

AnchorTransactionLoggerTransactionLoggerTransactionLogger

constructor

startTransaction

processLogger

AnchorProcessLoggerProcessLoggerProcessLogger

constructor

processStart

processEnd

processStateStart

processStateEnd

processChoice

processEvent

processValueString

processValueFloat

processValueDateTime

AnchorTransactionTransactionTransaction

end

startIO

AnchorIOIOIO

end

transactionLoggerMiddleware

Anchor
TransactionLogger
TransactionLogger
TransactionLogger

Anchor
ProcessLogger
ProcessLogger
ProcessLogger

Anchor
Transaction
Transaction
Transaction

Anchor
IO
IO
IO