Git Product home page Git Product logo

onyan's Introduction

Onyan [uhn-yuh n]

Pronounced 'Onion', a Bunyan plugin that sends logs to a configured API endpoint that consumes JSON.

Onyan uses request to make HTTP calls to the API endpoint.

Updates

1.1.0

  • Added a new configuration property: the ability to send a simple, handlebars-like schema to Onyan to format how errors are sent.
  • Added getDeepProp() utility to help with schema parsing.
  • Added scrubNewLines() utility to defend against new lines causing Unexpected token errors when parsing strings out of the schema.

Configurations

url

Type: String

The URL of API endpoint.

[ method ]

Type: { "POST", "GET" }

HTTP Method to use, either POST or GET.

[ headers ]

Type: Object

An object with key-value pairs of headers to include with the HTTP request.

[ custom ]

Type: Object

An object with key-value pairs to include with the HTTP request.

[ schema ]

Type: String

A Handlebars-like schema to format how errors are written out to the endpoint. You can include object properties inside {{}} and Onyan will attempt to parse the schema and insert the stream corresponding stream data.

Example

const bigPandaSchema = `{
	"app_key": "<My App Key>",
	"status": "critical",
	"host": "{{hostname}}",
	"check": "PID: {{pid}}",
	"description": "{{err.stack}}"
}`;

bunyan.createLogger({
	name: "myLog",
	stream: new Onyan({
		url: 'https://my.endpoint.com:80',
		method: 'POST',
		headers: {
			'Content-Type': 'application/json'
		},
		custom: {
			json: true
		},
		schema: bigPandaSchema
	})
});

onyan's People

Contributors

tim-steele avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.