Compare commits

..

8 Commits

Author SHA1 Message Date
4febec9e89 1.0.22 2018-11-05 23:52:40 +01:00
b65f3af9cf fix(core): update 2018-11-05 23:52:39 +01:00
373b02adb4 1.0.21 2018-11-05 23:41:43 +01:00
11b08cc0a3 fix(core): update 2018-11-05 23:41:43 +01:00
a586069305 1.0.20 2018-11-05 23:29:01 +01:00
8a8c4efcbb fix(core): update 2018-11-05 23:29:01 +01:00
dbb5843f52 1.0.19 2018-11-05 23:25:53 +01:00
d021e934b9 fix(readme): update 2018-11-05 23:25:53 +01:00
6 changed files with 86 additions and 13 deletions

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{ {
"name": "@mojoio/logdna", "name": "@mojoio/logdna",
"version": "1.0.18", "version": "1.0.22",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

View File

@ -1,6 +1,6 @@
{ {
"name": "@mojoio/logdna", "name": "@mojoio/logdna",
"version": "1.0.18", "version": "1.0.22",
"private": false, "private": false,
"description": "anunoffical package for the logdna api", "description": "anunoffical package for the logdna api",
"main": "dist/index.js", "main": "dist/index.js",

68
readme.md Normal file
View File

@ -0,0 +1,68 @@
# @mojoio/logdna
anunoffical package for the logdna api
## Availabililty
[![npm](https://mojoio.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/@mojoio/logdna)
[![git](https://mojoio.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/mojoio/logdna)
[![git](https://mojoio.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/mojoio/logdna)
[![docs](https://mojoio.gitlab.io/assets/repo-button-docs.svg)](https://mojoio.gitlab.io/logdna/)
## Status for master
[![build status](https://GitLab.com/mojoio/logdna/badges/master/build.svg)](https://GitLab.com/mojoio/logdna/commits/master)
[![coverage report](https://GitLab.com/mojoio/logdna/badges/master/coverage.svg)](https://GitLab.com/mojoio/logdna/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/logdna.svg)](https://www.npmjs.com/package/@mojoio/logdna)
[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/logdna/badge.svg)](https://snyk.io/test/npm/@mojoio/logdna)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
This package is an unofficial package for the logdna. It comes with the following festures:
* aggregates logs that require the same uri query parameters and sends them as bundle. This ensures the correct order of logs
* resends logs that failed to send.
* supports smartlog messages and the smartlog ecosystem
```typescript
import { ILogPackage } from '@pushrocks/smartlog-interfaces'
import { LogdnaAccount, LogdnaMessage } from '@mojoio/logdna';
// lets create a logDnaAccount
const logDnaAccount = new LogdnaAccount(process.env.LOGDNA_APIKEY);
// lets create a smartlog message (smartlog normally takes care of creating those objects)
const smartlogPackage: ILogPackage = {
timestamp: Date.now(),
type: 'log',
level: 'info',
context: {
company: 'Lossless GmbH',
companyunit: 'lossless.cloud',
containerName: 'ci-mojoio-logdna',
environment: 'test',
runtime: 'node',
zone: 'shipzone'
},
message: 'this is an awesome log message sent by the tapbundle test'
};
const logdnaMessage = LogdnaMessage.fromSmartLogPackage(smartlogPackage);
logDnaAccount.sendLogdnaMessage(logdnaMessage);
// alternatively simply send the smartlogPackage
// creation of the LogdnaMessage is done for you
logDnaAccount.sendSmartlogPackage(smartlogPackage)
// most of the above funtions return promises should you want to wait for a log to be fully sent
```
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://mojo.io)

View File

@ -31,7 +31,7 @@ tap.test('should create a standard log message', async () => {
}); });
tap.test('should send the message', async () => { tap.test('should send the message', async () => {
await testLogDnaAccount.sendLogDnaMessage(testLogMessage); await testLogDnaAccount.sendLogdnaMessage(testLogMessage);
}); });
tap.test('should send in order', async () => { tap.test('should send in order', async () => {

View File

@ -41,7 +41,7 @@ export class LogAggregator {
private async sendAggregatedLogs(logCandidate: ILogCandidate) { private async sendAggregatedLogs(logCandidate: ILogCandidate) {
this.logObjectMap.remove(logCandidate); this.logObjectMap.remove(logCandidate);
// lets post the message to logdna // lets post the message to logdna
await plugins.smartrequest.postJson(`${this.baseUrl}${logCandidate.urlIdentifier}&now=${Date.now()}` , { const response = await plugins.smartrequest.postJson(`${this.baseUrl}${logCandidate.urlIdentifier}&now=${Date.now()}` , {
headers: { headers: {
Authorization: this.createBasicAuth(), Authorization: this.createBasicAuth(),
charset: 'UTF-8' charset: 'UTF-8'
@ -50,5 +50,8 @@ export class LogAggregator {
lines: logCandidate.logLines lines: logCandidate.logLines
} }
}); });
if(response.statusCode !== 200) {
console.log(response.body);
}
} }
} }

View File

@ -22,21 +22,24 @@ export class LogdnaAccount {
* sends a logmessage * sends a logmessage
* async, so it returns a Promise. In most cases it does not make sense to wait for it though. * async, so it returns a Promise. In most cases it does not make sense to wait for it though.
*/ */
public async sendLogDnaMessage(logdnaMessageArg: LogdnaMessage) { public async sendLogdnaMessage(logdnaMessageArg: LogdnaMessage) {
const lm = logdnaMessageArg; const lm = logdnaMessageArg;
const euc = encodeURIComponent; const euc = encodeURIComponent;
// let construct the request uri const uriHostname = euc(lm.options.hostname);
const requestUrlWithParams = `?hostname=${euc(lm.options.hostname)}&mac=${euc( const uriMac = euc(lm.options.mac);
lm.options.mac const uriIp = euc(lm.options.ip);
)}&ip=1${euc(lm.options.ip)}&tags=${euc( const uriTags = euc(
(() => { (() => {
return lm.options.tags.reduce((reduced, newItem) => { return lm.options.tags.reduce((reduced, newItem) => {
return `${reduced},${newItem}`; return `${reduced},${newItem}`;
}); });
})() })()
)}`; );
// let construct the request uri
const requestUrlWithParams = `?hostname=${uriHostname}&mac=${uriMac}&ip=1${uriIp}&tags=${uriTags}`;
const logLine = { const logLine = {
timestamp: lm.options.timestamp, timestamp: lm.options.timestamp,
line: lm.options.line, line: lm.options.line,
@ -47,14 +50,13 @@ export class LogdnaAccount {
}; };
this.logAggregator.addLog(requestUrlWithParams, logLine); this.logAggregator.addLog(requestUrlWithParams, logLine);
} }
/** /**
* convenience function for smartlog * convenience function for smartlog
*/ */
public async sendSmartlogPackage(smartlogPackageArg: ILogPackage) { public async sendSmartlogPackage(smartlogPackageArg: ILogPackage) {
this.sendLogDnaMessage(LogdnaMessage.fromSmartLogPackage(smartlogPackageArg)); this.sendLogdnaMessage(LogdnaMessage.fromSmartLogPackage(smartlogPackageArg));
} }
/** /**