@avss-tech/logger 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @avss-tech/logger - Client SDK
|
|
2
2
|
|
|
3
|
-
Production-ready TypeScript SDK for the
|
|
3
|
+
Production-ready TypeScript SDK for the AVSS Centralized Logging Platform.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
@@ -22,7 +22,7 @@ npm install @avss-tech/logger
|
|
|
22
22
|
## Quick Start
|
|
23
23
|
|
|
24
24
|
```typescript
|
|
25
|
-
import {
|
|
25
|
+
import { AVSSLogger } from '@avss-tech/logger';
|
|
26
26
|
|
|
27
27
|
const logger = new AVSLogger({
|
|
28
28
|
project: 'my-app',
|
|
@@ -170,50 +170,6 @@ if (!result.success) {
|
|
|
170
170
|
}
|
|
171
171
|
```
|
|
172
172
|
|
|
173
|
-
## Best Practices
|
|
174
|
-
|
|
175
|
-
1. **Initialize once** - Create a single logger instance in your app
|
|
176
|
-
2. **Use async/await** - Handle promises properly for error handling
|
|
177
|
-
3. **Enable queue for production** - Batch logs to reduce server load
|
|
178
|
-
4. **Set custom headers** - Add authentication or tracking headers
|
|
179
|
-
5. **Monitor statistics** - Track logging performance
|
|
180
|
-
6. **Clean up on shutdown** - Call `destroy()` when app closes
|
|
181
|
-
|
|
182
|
-
## Project Structure
|
|
183
|
-
|
|
184
|
-
```
|
|
185
|
-
src/
|
|
186
|
-
├── index.ts # Main exports
|
|
187
|
-
├── logger.ts # Core SDK class
|
|
188
|
-
├── types.ts # TypeScript definitions
|
|
189
|
-
├── http-client.ts # HTTP client
|
|
190
|
-
├── retry.ts # Retry logic
|
|
191
|
-
├── queue.ts # Batch queue
|
|
192
|
-
├── validators.ts # Input validation
|
|
193
|
-
└── constants.ts # Configuration constants
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
## Build & Development
|
|
197
|
-
|
|
198
|
-
```bash
|
|
199
|
-
# Install dependencies
|
|
200
|
-
npm install
|
|
201
|
-
|
|
202
|
-
# Build the SDK
|
|
203
|
-
npm run build
|
|
204
|
-
|
|
205
|
-
# Watch mode
|
|
206
|
-
npm run watch
|
|
207
|
-
|
|
208
|
-
# Run tests
|
|
209
|
-
npm test
|
|
210
|
-
|
|
211
|
-
# Lint code
|
|
212
|
-
npm run lint
|
|
213
|
-
|
|
214
|
-
# Format code
|
|
215
|
-
npm run format
|
|
216
|
-
```
|
|
217
173
|
|
|
218
174
|
## License
|
|
219
175
|
|