Skip to content

Commit 5442be0

Browse files
committed
Updated README
1 parent 23203ce commit 5442be0

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
# ecs-logging-js
1+
<img align="right" width="auto" height="auto" src="https://www.elastic.co/static-res/images/elastic-logo-200.png">
2+
3+
# ecs-logging-js
4+
5+
[![Build Status](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-nodejs%2Fecs-logging-js-mbp%2Fmaster)](https://apm-ci.elastic.co/job/apm-agent-nodejs/job/ecs-logging-js-mbp/job/master/) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
6+
7+
This set of libraries allows you to transform your application logs to structured logs that comply with the [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current/ecs-reference.html).
8+
In combination with [filebeat](https://www.elastic.co/products/beats/filebeat) you can send your logs directly to Elasticsearch and leverage [Kibana's Logs UI](https://www.elastic.co/guide/en/infrastructure/guide/current/logs-ui-overview.html) to inspect all logs in one single place.
9+
See [ecs-logging](https://github.com/elastic/ecs-logging) for other ECS logging libraries and more resources about ECS & logging.
10+
11+
### Supported loggers
12+
- [winston](https://github.com/elastic/ecs-logging-js/tree/master/loggers/winston)
13+
- [morgan](https://github.com/elastic/ecs-logging-js/tree/master/loggers/morgan)
14+
15+
### References
16+
* Introduction to ECS [blog post](https://www.elastic.co/blog/introducing-the-elastic-common-schema).
17+
* Logs UI [blog post](https://www.elastic.co/blog/infrastructure-and-logs-ui-new-ways-for-ops-to-interact-with-elasticsearch).
18+
19+
## License
20+
This software is licensed under the [Apache 2 license](./LICENSE).

0 commit comments

Comments
 (0)