Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jmcdo29/ogma

A monorepo for the ogma logger and related packages
https://github.com/jmcdo29/ogma

gql hacktoberfest interceptor json json-logging logging module monorepo mtx nest nestjs nestjs-ogma ogma rest rpc ws

Last synced: 5 days ago
JSON representation

A monorepo for the ogma logger and related packages

Host: GitHub
URL: https://github.com/jmcdo29/ogma
Owner: jmcdo29
License: mit
Created: 2019-12-14T07:22:19.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-11-14T01:54:18.000Z (about 1 month ago)
Last Synced: 2024-12-13T21:49:03.442Z (11 days ago)
Topics: gql, hacktoberfest, interceptor, json, json-logging, logging, module, monorepo, mtx, nest, nestjs, nestjs-ogma, ogma, rest, rpc, ws
Language: TypeScript
Homepage: https://ogma.jaymcdoniel.dev
Size: 11.2 MB
Stars: 295
Watchers: 5
Forks: 36
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


![CI](https://github.com/jmcdo29/ogma/workflows/CI/badge.svg) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Coffee](https://badgen.net/badge/Buy%20Me/A%20Coffee/purple?icon=kofi)](https://www.buymeacoffee.com/jmcdo29) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f03955cfcc16468d9d05ec8f5fc4924e)](https://www.codacy.com/gh/jmcdo29/ogma/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jmcdo29/ogma&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f03955cfcc16468d9d05ec8f5fc4924e)](https://www.codacy.com/gh/jmcdo29/ogma/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jmcdo29/ogma&utm_campaign=Badge_Coverage)

  


    

  




# @Ogma

Ogma is a no-nonsense logger developed to make logging simple, and easy to read in development, while also having a powerful JSON form when it comes to production level logs, to make it easier to parse and consume by external services. This monorepo has all of the code for the base logger, the binary to rehydrate the JSON logs, and the [NestJS Module](https://nestjs.com) along with supported plugins for the module's interceptor.

## Packages

| Package | Description |

| --- | --- |

| [@ogma/cli](packages/cli) | The `ogma` command that can rehydrate ogma logs from JSON to human friendly formats |

| [@ogma/logger](packages/logger) | The base logger package that has the core implementation. Can be used from anything, does not need to be NestJS. |

| [@ogma/nestjs-module](packages/nestjs-module) | The core module package that sets up the `OgmaService` and `OgmaInterceptor` |

| [@ogma/platform-express](packages/platform-express) | A plugin for the OgmaInterceptor to properly handle HTTP requests from [Express](http://expressjs.com) |

| [@ogma/platform-fastify](packages/platform-fastify) | An HTTP plugin to properly log [Fastify](https://www.fastify.io/) requests |

| [@ogma/platform-graphql](packages/platform-graphql) | An HTTP/GQL plugin to properly log [GraphQL](https://www.apollographql.com/docs/) requests using the Express server |

| [@ogma/platform-graphql-fastify](packages/platform-graphql-fastify) | An HTTP/GQL plugin to properly log [GraphQL](https://www.apollographql.com/docs/) requests using the Fastify server |

| [@ogma/platform-grpc](packages/platform-grpc) | A microservice plugin to properly log [gRPC](https://docs.nestjs.com/microservices/gRPC) requests (in development) |

| [@ogma/platform-kafka](packages/platform-kafka) | A microservice plugin to properly log [Kafka](https://docs.nestjs.com/microservices/kafka) requests (in development) |

| [@ogma/platform-mqtt](packages/platform-mqtt) | A microservice plugin to properly log [MQTT](https://docs.nestjs.com/microservices/mqtt) requests (in development) |

| [@ogma/platform-nats](packages/platform-nats) | A microservice plugin to properly log [NATS](https://docs.nestjs.com/microservices/nats) requests (in development) |

| [@ogma/platform-rabbitmq](packages/platform-rabbitmq) | A microservice plugin to properly log [RabbitMQ](https://docs.nestjs.com/microservices/rabbitmq) requests (in development) |

| [@ogma/platform-redis](packages/platform-redis) | A microservice plugin to properly log [Redis](https://docs.nestjs.com/microservices/redis) requests (in development) |

| [@ogma/platform-socket.io](packages/platform-socket.io) | A Gateway plugin to properly log [Socket.io](https://socket.io) requests |

| [@ogma/platform-tcp](packages/platform-tcp) | A microservice plugin to properly log [TCP](https://docs.nestjs.com/microservices/basics) requests |

| [@ogma/platform-ws](packages/platform-ws) | A Gateway plugin to properly log [WS](https://github.com/websockets/ws) requests |

| [@ogma/styler](packages/styler) | A package for string styling. Similar to [chalk](https://github.com/chalk/chalk) just made as a part of the `@ogma/` namespace. |

## Contributors

This library is currently being maintained by [myself](https://github.com/jmcdo29), [Minsung Kim](https://github.com/jeffminsungkim), [Ruslan Gonzalez](https://github.com/ruslanguns), and [John Biundo](https://github.com/johnbiundo).

If you would like to contribute, please checkout the [CONTRIBUTING](./CONTRIBUTING.md) guidelines.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.