Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

logentries-query-stream

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

logentries-query-stream

Query and stream logs from Logentries.

  • 0.1.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Node module to stream logs from Logentries

logentries-query-stream

This module enables you to query log records in Logentries emitted as a stream. Example:

var le = require('logentries-query-stream')({
    account : '00000000-0000-0000-0000-000000000000',
    logset  : 'my_logs',
    log     : 'my_log'
});

le({ filter : '/info/i' })
    .on('data', log => {
        // Output log record message.
        console.log(log.m);
    });

Content

  • Install
  • Command line tool
  • API
  • Read More
  • License

Install

npm install --save logentries-query-stream

Command line tool

If you want to search and stream the logs using a command line tool, please check out logentries-query-cli module.

API

Before querying you need to connect to a specific log. Example:

var le = require('logentries-query-stream')({
    account : '00000000-0000-0000-0000-000000000000',
    logset  : 'my_logs',
    log     : 'my_log'
});

Options:

  • account: (UUID) - Account key used for authentication with Logentries
  • logset: (UUID|string) - ID or name of the log set to query
  • log: (UUID|string) - ID or name of the log to query
le(query) -> Readable Object Stream

Alias: le.json(query)

Makes a query and returns a stream emitting log records as JSON objects. Example:

le({
    start  : Date.now() - 20*60*1000,
    end    : Date.now(),
    limit  : 100
})
    .on('data', log => console.log(log.m));

Query:

  • start: (Unix time in milliseconds) - Defines time range to search
  • end: (Unix time in milliseconds) - Defines time range to search
  • filter: (String) - Logentries formatted search query
  • limit: (Integer) - Limit number of returned log records

Format of emitted log records:

  • r: (UUID) - ID of the log
  • s: Not documented
  • t: (Unix time in milliseconds) - When the record was received
  • m: (String) - Text message of the record
le.raw(query) -> Readable Stream

Makes a query and returns a stream emitting log records as raw JSON or text. Example:

le.raw({
    format : 'text',
    start  : Date.now() - 20*60*1000,
    end    : Date.now(),
    limit  : 100
}).pipe(fs.createWriteStream('example.log'));

The query have the same options as the le(query) with the addition of one extra property:

  • format: (String) - Either 'json' (default) or 'text' for line-based format

Read More

You can read more about the workings of the Logentries API here.

License

Code is licensed under MIT, please see license.md file for details.

Keywords

FAQs

Package last updated on 24 Jun 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc