Skip to content

Commit

Permalink
DOC: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael O'Brien committed Sep 13, 2021
1 parent f70b04c commit 06d0e5a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
![SenseLogs](https://www.sensedeep.com/images/senselogs.png)

*Observability without the crushing performance cost*

[![Build Status](https://img.shields.io/github/workflow/status/sensedeep/senselogs/build)](https://img.shields.io/github/workflow/status/sensedeep/senselogs/build)
[![npm](https://img.shields.io/npm/v/senselogs.svg)](https://www.npmjs.com/package/senselogs)
[![npm](https://img.shields.io/npm/l/senselogs.svg)](https://www.npmjs.com/package/senselogs)
Expand All @@ -13,24 +15,25 @@ While there are many other good logging libraries that claim to be fast, they we

Furthermore, serverless apps have special requirements like minimizing cold-start time, dynamic log filtering control without redeploying and being able to capture detailed context and request information without modifying your functions.

SenseLogs is designed to do this, simply and elegantly.
SenseLogs is designed to do this, simply and elegantly. SenseLogs makes it easy to instrument your code for maximum Observability without a crushing performance penalty.

## SenseLogs Features

* Extremely fast initialization time to shorten cold-starts.
* Up to 7 times faster than the nearest alternative.
* Emit log data with rich context for maximum Observability.
* Flexible log channels and filters.
* Dynamic log control to change log filters without redeploying.
* Emits logs in JSON with full context.
* Extremely fast initialization time to shorten cold-starts.
* Up to 7 times faster than the nearest alternative.
* Log sampling to emit increased logs for a percentage of requests.
* Emits logs in JSON with rich context.
* For local debugging, emits in human readable formats.
* Inheriting child log instances for per-module logging.
* Stack capture for uncaught exceptions.
* Easily emit CloudWatch custom metrics using EMF.
* Integrates with SenseDeep developer studio.
* No dependencies.
* Clean, readable small code base (<500 lines).
* Integrates with [SenseDeep](https://www.sensedeep.com) developer studio.
* Full TypeScript support.
* Clean, readable small code base (<500 lines).
* No dependencies.


## Quick Tour
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "senselogs",
"version": "1.0.0",
"version": "1.0.1",
"description": "Simple, dynamic, blazing fast serverless logging",
"main": "dist/cjs/index.js",
"module": "dist/mjs/index.js",
Expand All @@ -13,11 +13,11 @@
},
"keywords": [
"serverless",
"lambda",
"log",
"logs",
"logging",
"library",
"lambda",
"observability",
"typescript",
"aws",
"amazon"
Expand Down

0 comments on commit 06d0e5a

Please sign in to comment.