Gathering detailed insights and metrics for acelogger
Installations
npm install aceloggerDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=8.9
Node Version
18.17.1
NPM Version
9.6.7
Score
76.5
Supply Chain
98.7
Quality
75.9
Maintenance
100
Vulnerability
99.6
License
Releases
Unable to fetch releases
Contributors
1
Unable to fetch Contributors
Languages
3
TypeScript
JavaScript
HTML
TypeScript (91.76%)
JavaScript (7.91%)
HTML (0.33%)
Developer
wenshin
Download Statistics
Total Downloads
10,072
Last Day
2
Last Week
20
Last Month
38
Last Year
1,172
GitHub Statistics
1 Stars
36 Commits
3 Watching
1 Branches
1 Contributors
Bundle Size
12.05 kB
Minified
3.97 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.17.6
Package Id
acelogger@0.17.6
Unpacked Size
357.50 kB
Size
58.90 kB
File Count
143
NPM Version
9.6.7
Node Version
18.17.1
Publised On
12 Jan 2024
Total Downloads
Cumulative downloads
Total Downloads
10,072
Last day
0%
2
Compared to previous day
Last week
122.2%
20
Compared to previous week
Last month
-51.9%
38
Compared to previous month
Last year
-55.9%
1,172
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Versions
Acelogger
Acelogger is a light and powerful logger with tracing and metrics logging. It is inspired by opentelemetry-js.
Design
Why make a new one?
opentelemetry, opentracing and other libraries, are hard to understand and use.
-
too many concepts. TracerProvider, Tracer, SpanProcessor, Span, Logger, Event, Metric, MetricProvider etc.
-
large code size
- @opentelemetry/tracing minimized 39.9kb
- @opentelemetry/api minimized 13.8kb
- @opentelemetry/web minimized 46.1kb
- acelogger minimized < 10kb
-
bad design
- circulation dependencies
- do not support tree shaking
Core Concepts
The logging, tracing and metrics will generate events which logged by logger, event have different alert level and event type.
- tracer is just the factory class for span.
- logger use tracer to create span and span context.
- logger can create, record and export events.
- define exporter with alert level, includes: debug, info, warn, error, fatal
- exporter will sample the events
- event type includes:
- log event, for message logging
- store, count and timing events, for metric reporting
- span start and span end events, for tracing
Usage
Install
$ npm install --save acelogger
Example
1import ace, { 2 ConsoleExporterWeb, 3 LogLevel, 4 CanonicalCode, 5 isMetricEvent, 6} from 'acelogger'; 7 8ace.logger.setAttributes({ 9 os: 'MacOS', 10 osVersion: '13.0', 11}); 12 13class MetricExporterWeb implements LoggerEventExporter { 14 export(evts: LoggerEvent[]) { 15 const metricEvents = evts.filter(isMetricEvent); 16 console.log(metricEvents); 17 } 18} 19 20// set event exporter, for mesage logging 21ace.setExporter(LogLevel.Debug, new ConsoleExporterWeb()); 22// set event exporter, for metric reportings 23ace.setExporter(LogLevel.Debug, new MetricExporterWeb()); 24 25// log info level message 26ace.logger.info('test info'); 27ace.logger.storeMetrics({ 28 metrics: { 29 memoryUsage: 0.1, 30 cpuUsage: 0.5, 31 }, 32}); 33ace.logger.event('button_click'); 34 35// creat a span logger 36const spanLogger = ace.logger.startSpan('first.span', { 37 parent: ace.tracer.createSpanContext(), 38}); 39 40spanLogger.setAttributes({ 41 path: '/path/to', 42}); 43 44spanLogger.info('test info'); 45spanLogger.event('button_click'); 46 47spanLogger.endSpan({ 48 status: CanonicalCode.OK, 49});
Customize Logger
when logging in module, you can customize a scoped logger.
1import globaleAce, { 2 SimpleManager, 3 LogLevel, 4 ConsoleExporterWeb, 5} from 'acelogger'; 6const manager = new SimpleManager(); 7 8manager.logger.setAttributes({ 9 app: globaleAce.logger.getAttributes().app, 10 appVersion: globaleAce.logger.getAttributes().appVersion, 11 lib: 'my-module@0.0.1', 12}); 13 14// init logger exporter 15manager.setExporter(LogLevel.Debug, new ConsoleExporterWeb()); 16manager.setBufferSize(0); 17 18export { manager as ace };
Customize Exporter
you can customize a exporter
1import ace, { TraceFlags, SimpleManager, LogLevel, ConsoleExporterWeb, isCountEvent } from 'acelogger'; 2 3// init logger exporter 4manager.setExporter(LogLevel.Debug, { 5 export( 6 events: LoggerEvent[], 7 resultCallback: (result: ExportResult) => void 8 ): void { 9 for (const evt of events) { 10 if (evt.traceFlags === TraceFlags.SAMPLED && !isSimpled(evt)) { 11 return; 12 } 13 if (evt.metrics) { 14 logMetric(evt); 15 } else if (isCountEvent(evt)) { 16 logCount(evt) 17 } 18 logToFile(evt); 19 } 20 }; 21});
API
ChangeLog
2022-05-07 0.14.3
- fix: console exporter bug
2022-04-27 0.14.2
- chore enhancement
2022-04-27 0.14.0
- upgrade opentelemetry library with break change
2022-01-24 0.13.5
- feat: remove duration infomation in endSpan message
2022-01-14 0.13.4
- feat: set logStart default is true
- feat: add IDGenerator api
2022-01-13 0.13.3
- fix: default span id start with 0
- feat: add userStartTime to span start event
2021-10-18 0.13.2
- refactor: new exporter api (break change)
2021-10-18 0.12.1
- refactor: add some util for event name and metric name
2021-10-11 0.12.0
- feat: enhancement default traceId and spanId
2021-10-08 0.11.0
- feat: support set flush ready flag
2021-10-08 0.10.0
- feat: remove setBufferSize
2021-04-23 0.9.2
- feat: chage samplingRatio to samplingRate
2021-04-20 0.9.0
- feat: SimpleManager support customize flush delay time
2021-04-20 0.8.1
- feat: add samplingRatio for event and disable log start event by default
2021-04-19 0.8.0
- feat: startSpan add logStart param to disable start span event
2021-03-02 0.7.5
- fix: change __debug to __ace_debug
2021-01-03 0.7.4
- feat: support data option for Logger.startSpan
- fix: logger.error and fatal not support string as message
2020-12-12 0.7.3
- optimize: async flush events
- optimize: console expoter default only print warn, error, fatal logs
2020-11-18 0.7.2
- fix: use strict rule for function type
2020-11-18 0.7.1
- fix: storeMetrics support status
2020-11-18 0.7.0 Breaking Change
- refactor: LoggerEvent structure changed
- refactor: remove isCountEvent
2020-11-17 0.6.0 Breaking Change
- refactor: move setExporter & setBufferSize to Manager
2020-11-17 0.5.2
- feat: move spanId and traceId to LoggerEvent.data
2020-11-13 0.5.1
- update README.md
2020-11-12 0.5.0 Breaking Change
- remove api count, timing, store
- add storeMetrics, event api
2020-11-08 0.4.0
- remove some default attributes of LoggerEvent
2020-11-07 0.3.0
- add fatal for Logger
- Logger.count only record 1 time
- LoggerEvent add metrics property and data property will without metrics
2020-10-11 0.2.2
- add traceFlags for LoggerEvent, which can get sampled flag
- change endSpan message format, now have duration and customized message
2020-09-25 0.2.1
- refactor isMetricEvent
2020-09-24 0.2.0
- break change SimpleLogger api, to reduce duplicate logs
2020-09-24 0.1.1
- remove unsafe dependencies
2020-09-23 0.1.0
- refactor: new Manager api
2020-08-27 0.0.6
- fix: build with no files
2020-08-27 0.0.5
- fix: console logger name is undefined
2020-08-12 0.0.4
- remove span methods
2020-08-10 0.0.3
- new singleton api
2020-08-02 0.0.2
- fix opentelemetry-api do not support tree shaking problem
2020-08-02 0.0.1
- first version with logger and tracer
No vulnerabilities found.
No security vulnerabilities found.