Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 13 additions & 23 deletions docs/libraries/node/v1/logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import TabItem from '@theme/TabItem';

# TBPlusLogger

The `TBPlusLogger` is a simple and customizable HTTP logger for the `TBPlusSDK`.
The `TBPlusLogger` is exported from `@tatrabanka/tatrapayplus-node` (since 1.0.2) and is a simple, customizable HTTP logger for the `TBPlusSDK`.
It helps you debug API calls by logging outgoing requests and incoming responses, while safely masking sensitive data.

---
Expand All @@ -21,11 +21,12 @@ It helps you debug API calls by logging outgoing requests and incoming responses
The logger masks sensitive values before outputting them:

- **Headers**: `Authorization`
- **Body fields (reqest and response)**: `client_id`, `client_secret`, `access_token`
- **Body fields (request and response)**: `client_id`, `client_secret`, `access_token`

Example masked output: `client_secret=abcde*************uvxyz`

You can disable masking by passing false to the constructor:
You can disable masking by passing `false` to the constructor:

```javascript
const logger = new TBPlusLogger(false);
```
Expand All @@ -34,43 +35,32 @@ const logger = new TBPlusLogger(false);

### Step 1: Create a Logger Subclass


```javascript
import { TBPlusLogger } from "./logger";
import { TBPlusLogger } from "@tatrabanka/tatrapayplus-node";

class ConsoleLogger extends TBPlusLogger {
protected writeLine(line: string): void {
console.log("[ConsoleLogger]", line);
}
}
}

```

### Step 2: Use Logger with the SDK

```javascript
import { TBPlusSDK } from "tbplus-sdk";
import { TBPlusSDK, TBPlusLogger } from "@tatrabanka/tatrapayplus-node";

const logger = new ConsoleLogger();

const sdk = new TBPlusSDK(
API_KEY,
API_SECRET,
"192.0.2.123",
{},
logger
const sdk = new TBPlusSDK(API_KEY, API_SECRET, {}, logger);

const { data, error } = await sdk.createPayment(
paymentBody,
REDIRECT_URI,
"192.0.2.123"
);
```

## Customization
You can configure which fields are masked:

```javascript
logger.maskSensitiveData = true;
logger.maskBodyFields = ["client_id", "client_secret", "access_token"];
logger.maskHeaderFields = ["authorization"];
```

## Example output
```
Expand Down Expand Up @@ -105,4 +95,4 @@ logger.maskHeaderFields = ["authorization"];
...
]
}
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ import TabItem from '@theme/TabItem';

# Logging

# TatrapayPlusLogger
# TBPlusLogger

`TatrapayPlusLogger` je jednoduchý a prispôsobiteľný HTTP logger pre `TBPlusSDK`.
`TBPlusLogger` je exportovaný z `@tatrabanka/tatrapayplus-node` (od verzie 1.0.2) a slúži ako jednoduchý a prispôsobiteľný HTTP logger pre `TBPlusSDK`.
Pomáha vám ladiť volania API zaznamenávaním odchádzajúcich požiadaviek a prichádzajúcich odpovedí a zároveň bezpečne maskuje citlivé údaje.

---
Expand All @@ -14,18 +14,19 @@ Pomáha vám ladiť volania API zaznamenávaním odchádzajúcich požiadaviek a

- Zaznamenáva metadáta **žiadostí a odpovedí**
- Vstavané **maskovanie polí**
- Rozšíriteľné pomocou `write_line()`
- Rozšíriteľné pomocou `writeLine()` na prispôsobenie výstupu (konzola, súbor atď.)

## Maskované polia

Logger maskuje citlivé hodnoty pred ich výstupom:

- **Headers**: `Authorization`
- **Body fields (reqest and response)**: `client_id`, `client_secret`, `access_token`
- **Body fields (request and response)**: `client_id`, `client_secret`, `access_token`

Príklad maskovaného výstupu: `client_secret=abcde*************uvxyz`

Maskovanie môžete zakázať nastavením parametra `mask_sensitive_data=False` počas inicializácie loggeru:
Maskovanie môžete vypnúť odovzdaním `false` konštruktoru:

```javascript
const logger = new TBPlusLogger(false);
```
Expand All @@ -34,43 +35,32 @@ const logger = new TBPlusLogger(false);

### Krok 1: Vytvorenie podtriedy Loggeru


```javascript
import { TBPlusLogger } from "./logger";
import { TBPlusLogger } from "@tatrabanka/tatrapayplus-node";

class ConsoleLogger extends TBPlusLogger {
protected writeLine(line: string): void {
console.log("[ConsoleLogger]", line);
}
}
}

```

### Krok 2: Vloženie loggeru do klienta

```javascript
import { TBPlusSDK } from "tbplus-sdk";
import { TBPlusSDK, TBPlusLogger } from "@tatrabanka/tatrapayplus-node";

const logger = new ConsoleLogger();

const sdk = new TBPlusSDK(
API_KEY,
API_SECRET,
"192.0.2.123",
{},
logger
const sdk = new TBPlusSDK(API_KEY, API_SECRET, {}, logger);

const { data, error } = await sdk.createPayment(
paymentBody,
REDIRECT_URI,
"192.0.2.123"
);
```

## Prispôsobenie
Maskovacie polia si môžete prispôsobiť:

```javascript
logger.maskSensitiveData = true;
logger.maskBodyFields = ["client_id", "client_secret", "access_token"];
logger.maskHeaderFields = ["authorization"];
```

## Príklad výstupu
```
Expand Down Expand Up @@ -105,4 +95,4 @@ logger.maskHeaderFields = ["authorization"];
...
]
}
```
```
Loading