1- # LogWard Node.js SDK
1+ # LogTide Node.js SDK
22
3- Official Node.js SDK for LogWard with advanced features: retry logic, circuit breaker, query API, live streaming, and middleware support.
3+ Official Node.js SDK for LogTide with advanced features: retry logic, circuit breaker, query API, live streaming, and middleware support.
44
55## Features
66
@@ -20,19 +20,19 @@ Official Node.js SDK for LogWard with advanced features: retry logic, circuit br
2020## Installation
2121
2222``` bash
23- npm install @logward-dev /sdk-node
23+ npm install @logtide /sdk-node
2424# or
25- pnpm add @logward-dev /sdk-node
25+ pnpm add @logtide /sdk-node
2626# or
27- yarn add @logward-dev /sdk-node
27+ yarn add @logtide /sdk-node
2828```
2929
3030## Quick Start
3131
3232``` typescript
33- import { LogWardClient } from ' @logward-dev /sdk-node' ;
33+ import { LogTideClient } from ' @logtide /sdk-node' ;
3434
35- const client = new LogWardClient ({
35+ const client = new LogTideClient ({
3636 apiUrl: ' http://localhost:8080' ,
3737 apiKey: ' lp_your_api_key_here' ,
3838});
@@ -56,7 +56,7 @@ process.on('SIGINT', async () => {
5656
5757| Option | Type | Default | Description |
5858| --------| ------| ---------| -------------|
59- | ` apiUrl ` | ` string ` | ** required** | Base URL of your LogWard instance |
59+ | ` apiUrl ` | ` string ` | ** required** | Base URL of your LogTide instance |
6060| ` apiKey ` | ` string ` | ** required** | Project API key (starts with ` lp_ ` ) |
6161| ` batchSize ` | ` number ` | ` 100 ` | Number of logs to batch before sending |
6262| ` flushInterval ` | ` number ` | ` 5000 ` | Interval in ms to auto-flush logs |
@@ -78,7 +78,7 @@ process.on('SIGINT', async () => {
7878### Example: Full Configuration
7979
8080``` typescript
81- const client = new LogWardClient ({
81+ const client = new LogTideClient ({
8282 apiUrl: ' http://localhost:8080' ,
8383 apiKey: ' lp_your_api_key_here' ,
8484
@@ -204,7 +204,7 @@ client.withNewTraceId(() => {
204204### Auto Trace ID Mode
205205
206206``` typescript
207- const client = new LogWardClient ({
207+ const client = new LogTideClient ({
208208 apiUrl: ' http://localhost:8080' ,
209209 apiKey: ' lp_your_api_key_here' ,
210210 autoTraceId: true , // Every log gets a unique trace ID
@@ -323,16 +323,16 @@ Auto-log all HTTP requests and responses.
323323
324324``` typescript
325325import express from ' express' ;
326- import { LogWardClient , logWardMiddleware } from ' @logward-dev /sdk-node' ;
326+ import { LogTideClient , logTideMiddleware } from ' @logtide /sdk-node' ;
327327
328328const app = express ();
329- const logger = new LogWardClient ({
329+ const logger = new LogTideClient ({
330330 apiUrl: ' http://localhost:8080' ,
331331 apiKey: ' lp_your_api_key_here' ,
332332});
333333
334334app .use (
335- logWardMiddleware ({
335+ logTideMiddleware ({
336336 client: logger ,
337337 serviceName: ' express-api' ,
338338 logRequests: true ,
@@ -361,15 +361,15 @@ app.listen(3000);
361361
362362``` typescript
363363import Fastify from ' fastify' ;
364- import { LogWardClient , logWardFastifyPlugin } from ' @logward-dev /sdk-node' ;
364+ import { LogTideClient , logTideFastifyPlugin } from ' @logtide /sdk-node' ;
365365
366366const fastify = Fastify ();
367- const logger = new LogWardClient ({
367+ const logger = new LogTideClient ({
368368 apiUrl: ' http://localhost:8080' ,
369369 apiKey: ' lp_your_api_key_here' ,
370370});
371371
372- await fastify .register (logWardFastifyPlugin , {
372+ await fastify .register (logTideFastifyPlugin , {
373373 client: logger ,
374374 serviceName: ' fastify-api' ,
375375 logRequests: true ,
@@ -404,7 +404,7 @@ process.on('SIGTERM', async () => {
404404### 2. Use Global Metadata
405405
406406``` typescript
407- const client = new LogWardClient ({
407+ const client = new LogTideClient ({
408408 apiUrl: ' http://localhost:8080' ,
409409 apiKey: ' lp_your_api_key_here' ,
410410 globalMetadata: {
@@ -419,7 +419,7 @@ const client = new LogWardClient({
419419### 3. Enable Debug Mode in Development
420420
421421``` typescript
422- const client = new LogWardClient ({
422+ const client = new LogTideClient ({
423423 apiUrl: ' http://localhost:8080' ,
424424 apiKey: ' lp_your_api_key_here' ,
425425 debug: process .env .NODE_ENV === ' development' ,
@@ -459,11 +459,11 @@ app.use((req, res, next) => {
459459
460460## API Reference
461461
462- ### LogWardClient
462+ ### LogTideClient
463463
464464#### Constructor
465465``` typescript
466- new LogWardClient (options : LogWardClientOptions )
466+ new LogTideClient (options : LogTideClientOptions )
467467```
468468
469469#### Logging Methods
@@ -516,12 +516,12 @@ Fully typed with strict TypeScript support:
516516
517517``` typescript
518518import type {
519- LogWardClient ,
519+ LogTideClient ,
520520 LogEntry ,
521521 QueryOptions ,
522522 LogsResponse ,
523523 ClientMetrics ,
524- } from ' @logward-dev /sdk-node' ;
524+ } from ' @logtide /sdk-node' ;
525525```
526526
527527---
@@ -551,11 +551,11 @@ MIT
551551
552552## Contributing
553553
554- Contributions are welcome! Please open an issue or PR on [ GitHub] ( https://github.com/logward-dev/logward -sdk-node ) .
554+ Contributions are welcome! Please open an issue or PR on [ GitHub] ( https://github.com/logtide/logtide -sdk-node ) .
555555
556556---
557557
558558## Support
559559
560- - ** Documentation** : [ https://logward .dev/docs ] ( https://logward .dev/docs )
561- - ** Issues** : [ GitHub Issues] ( https://github.com/logward-dev/logward -sdk-node/issues )
560+ - ** Documentation** : [ https://logtide .dev/docs ] ( https://logtide .dev/docs )
561+ - ** Issues** : [ GitHub Issues] ( https://github.com/logtide/logtide -sdk-node/issues )
0 commit comments