Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanwalther/audit-log-service
Simple log service (to MongoDB).
https://github.com/stefanwalther/audit-log-service
logging logging-server logs mongodb sammler
Last synced: about 5 hours ago
JSON representation
Simple log service (to MongoDB).
- Host: GitHub
- URL: https://github.com/stefanwalther/audit-log-service
- Owner: stefanwalther
- Created: 2016-12-22T21:32:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T05:01:46.000Z (over 3 years ago)
- Last Synced: 2024-11-01T07:33:40.873Z (5 days ago)
- Topics: logging, logging-server, logs, mongodb, sammler
- Language: JavaScript
- Size: 251 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# audit-log-service
> Simple logging service for sammler.
[](https://circleci.com/gh/sammler/audit-log-service)
## Purpose
_audit-log-service_ is a very simple logging service, which just acts as a temporary solution to get some logging up and running.
It logs to MongoDB and exposes some endpoints to create and to retrieve logs.
The solution was primarily created, because the [ELK-stack](https://github.com/deviantony/docker-elk) just felt to heavy (> 1.5 GB RAM needed) for _sammler_.
## Configuration
_audit-log-service_ can be configured by the following environment variables:
**General:**
- `PORT` - The port to run the REST API (defaults to `3004`).
**MongoDB:**
- `MONGODB_DEBUG` - Whether to use the Mongoose debug mode or not, defaults to `false`.
- `MONGODB_HOST` - MongoDB host, defaults to `localhost`.
- `MONGODB_PORT` - MongoDB port, defaults to `27017`.
- `MONGODB_DATABASE` - MongoDB database, defaults to `sammlerio`.
**NATS-STREAMING:**
- `NATS_STREAMING_HOST`
- `NATS_STREAMING_PORT`
## Features
The functionality of _audit-log-service_ is documented in a swagger file, available at [http://localhost:3004/api-docs](http://localhost:3004/api-docs) when running the image.
Alternatively api-docs is also available [here](./docs/api-docs.md).
## Development
Run
```sh
$ npm run dc-dev-up
```
Which will spin up a MongoDB instance at port 27018 (to prevent conflicts with the default port).
Then run the tests:
```
$ npm run test
```
## Author
**Stefan Walther**
* [twitter](http://twitter.com/waltherstefan)
* [github.com/stefanwalther](http://github.com/stefanwalther)
* [LinkedIn](https://www.linkedin.com/in/stefanwalther/)
## License
MIT