69 lines
3.0 KiB
Markdown
69 lines
3.0 KiB
Markdown
|
# logdna
|
||
|
|
anunoffical package for the logdna api
|
||
|
|
|
||
|
|
## Availabililty
|
||
|
|
[](https://www.npmjs.com/package/@mojoio/logdna)
|
||
|
|
[](https://GitLab.com/mojoio/logdna)
|
||
|
|
[](https://github.com/mojoio/logdna)
|
||
|
|
[](https://mojoio.gitlab.io/logdna/)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
[](https://GitLab.com/mojoio/logdna/commits/master)
|
||
|
|
[](https://GitLab.com/mojoio/logdna/commits/master)
|
||
|
|
[](https://www.npmjs.com/package/@mojoio/logdna)
|
||
|
|
[](https://snyk.io/test/npm/@mojoio/logdna)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](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.
|
||
|
|
|
||
|
|
> licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||
|
|
|
||
|
|
[](https://mojo.io)
|