Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #35

Merged
merged 1 commit into from
Sep 30, 2023
Merged

Update README.md #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# `EventLoggerRails`

🎉 **Welcome to EventLoggerRails: Your Event Logging Sidekick!** 🎉
## 🎉 **Enter the EventLoggerRails Dimension: Your Companion in the Chronicle of Events!** 🎉

Are you tired of navigating through logs as if you're lost in the labyrinth of the Wired, searching for that elusive piece of data? Say "Hello, World!" to `EventLoggerRails`, the Rails engine that turns your logs into a treasure trove of insights! 🌟

## Picture This
### Visualize This

With a straightforward and centralized config file, you can easily define all the events that make your business tick. Then watch as `EventLoggerRails` transforms these events into dazzling JSON logs! 🎇
In a single, centralized config file, decipher the events that pulse through the veins of your business. Once set, let `EventLoggerRails` weave them into intricate patterns of JSON logs that shimmer like a digital mirage. 🎇

## But Wait, There's More!
### Yet, The Nexus Expands

Seamlessly funnel these JSON marvels into analytics platforms like OpenSearch, and behold the magic of data visualization and real-time analysis. 📊✨
Channel these JSON enigmas directly into analytic realms like OpenSearch. There, witness the alchemy of data taking form through real-time visualizations and analysis. 📊✨

## Why Choose `EventLoggerRails`?
### Why Choose `EventLoggerRails`?

- 🚀 **Fast Setup**: Get your logging up and running in minutes, not hours!
- 🌐 **Team-Friendly Event Registry**: Simplify how your team defines and logs business-critical events.
Expand All @@ -23,8 +23,8 @@ Don't let crucial events get lost in the digital void. Make your app's logging a

## Usage

You can define a registry of events that your application emits via the config file (`config/event_logger_rails.yml`).
The events that you define are placed in the `registered_events` structure in the config file.
You can define a registry of events your application emits via the config file (`config/event_logger_rails.yml`).
The events you define are placed in the `registered_events` structure in the config file.

For example, to register a user signup event, first define the event as a registered event:

Expand Down Expand Up @@ -179,7 +179,7 @@ class User < ApplicationRecord
end
```

By default, `event_logger_rails` will include the model name and instance ID, along with whatever data is passed.
By default, `event_logger_rails` will include the model name, instance ID, and whatever data is passed.

```json
{
Expand Down Expand Up @@ -305,7 +305,7 @@ bin/rails generate event_logger_rails:install
Add your events to the generated config file following the structure of the examples.

By default, `event_logger_rails` outputs to a separate log file (`log/event_logger_rails.#{Rails.env}.log`) from normal Rails log output, allowing
you to ingest these logs independently. If you wish to set an alternative log device to capture output , you can configure it in `config/application.rb`:
you to ingest these logs independently. If you wish to set an alternative log device to capture output, you can configure it in `config/application.rb`:

```ruby
Rails.application.configure do |config|
Expand All @@ -315,7 +315,7 @@ end

## Contributing

Contributions are welcome. Feel free to open a PR.
Your inputs echo in this realm. Venture forth and materialize your thoughts through a PR.

## License

Expand Down
Loading