aliyun-sls-stream - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

index.js

@@ -60,3 +60,5 @@ 'use strict'
     if (typeof chunk === 'string') {
-
+      chunk = {
+        message: chunk
+      }
     }
@@ -63,0 +65,0 @@ this.__cache.push(Object.assign({}, chunk, {

package.json

 {
   "name": "aliyun-sls-stream",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -7,5 +7,23 @@ # 阿里云 SLS Stream
 
-1. 通过 `bunyan` 使用
+1. 直接使用
 
 ```js
+const AliyunSlsStream = require('aliyun-sls-stream')
+
+const stream = new AliyunSlsStream({
+  accessKeyId: 'your_very_secured_access_key_id',
+  secretAccessKey: 'your_very_secured_secret_access_key',
+  endpoint: 'an_aliyun_endpoint_for_sls', // refer to https://help.aliyun.com/document_detail/29008.html?spm=5176.doc28984.2.5.CMkSh1 for more details
+  project: process.env.ALIYUN_PROJECT,
+  logStore: process.env.ALIYUN_LOG_STORE
+})
+
+stream.write('Hello from the other side')
+stream.write({ foo: 'bar' })
+
+```
+
+2. 通过 `bunyan` 使用
+
+```js
 const bunyan = require('bunyan')
@@ -12,0 +30,0 @@ const AliyunSlsStream = require('aliyun-sls-stream')

test/index.test.js

@@ -7,2 +7,9 @@ const { test } = require('ava')
 test.beforeEach(async t => {
+  const stream = new AliyunSlsStream({
+    accessKeyId: process.env.ALIYUN_ACCESS_KEY_ID,
+    secretAccessKey: process.env.ALIYUN_SECRET_ACCESS_KEY,
+    endpoint: process.env.ALIYUN_ENDPOINT,
+    project: process.env.ALIYUN_PROJECT,
+    logStore: process.env.ALIYUN_LOG_STORE
+  })
   const log = bunyan.createLogger({
@@ -12,9 +19,3 @@ name: 'foo',
       type: 'raw',
-      stream: new AliyunSlsStream({
-        accessKeyId: process.env.ALIYUN_ACCESS_KEY_ID,
-        secretAccessKey: process.env.ALIYUN_SECRET_ACCESS_KEY,
-        endpoint: process.env.ALIYUN_ENDPOINT,
-        project: process.env.ALIYUN_PROJECT,
-        logStore: process.env.ALIYUN_LOG_STORE
-      }),
+      stream,
       reemitErrorEvents: true
@@ -24,6 +25,6 @@ }],
   })
-  t.context = { log }
+  t.context = { log, stream }
 })
 
-test('write logs', async t => {
+test('write bunyan logs', async t => {
   const { log } = t.context
@@ -37,1 +38,9 @@ log.debug('foobar')
 })
+
+test('write logs', async t => {
+  const { stream } = t.context
+  stream.write({ from: 'stream' })
+
+  await new Promise(resolve => setTimeout(resolve, 2000))
+  t.pass()
+})

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

134118

increased by0.57%

Lines of code

103

increased by10.75%

Number of lines in readme file

52

increased by52.94%

No dependency changes