/ElasticSearch-Aggregation

Primary LanguageC#


ElasticSearch Aggregation Project

🚀 An application built using .NET Core 8 for performing data aggregation with ElasticSearch.
Report Bug · Request Feature

📌 About The Project

This project demonstrates how to use ElasticSearch for data aggregation using a sample error_log structure. It is built with .NET Core 8 and utilizes ElasticSearch's aggregation features to group and retrieve data.

Mock data is generated and fed into the system using ElasticSearch DevTools.

(back to top)

🛠 Built With

(back to top)

🚀 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

  • Ensure you have ElasticSearch and Kibana running. You can either use a locally installed instance or one running in Docker.
  • Install the necessary packages using the following commands.

Installation

  1. Clone the repo: 
    git clone https://github.com/bgraokmush/ElasticSearch-Aggregation.git
  2. Install the required .NET dependencies: 
    dotnet add package Elastic.Clients.Elasticsearch --version 8.11.0
dotnet add package Elastic.Transport --version 8.11.0
  3. Run the application: 
    dotnet run

You can now interact with the system and send aggregation queries via the integrated APIs.

(back to top)

📊 Usage

This project groups error logs and retrieves aggregated data using ElasticSearch's Aggregation API. Mock data for testing can be inserted using the DevTools in Kibana.

For detailed examples, please refer to the Documentation.

(back to top)

🛣 Roadmap

  • Initial setup with ElasticSearch and Kibana
  • Aggregation queries for grouping data
  • Improve error logging mechanism
  • Add more detailed query examples for complex aggregations

See the open issues for a full list of proposed features (and known issues).

(back to top)

💡 Contributing

Contributions are what make the open-source community amazing! Feel free to make this project better by following these steps:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Any enhancements, bug fixes, or feature additions are greatly appreciated!

(back to top)

📄 License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

✉️ Contact

X Profile - @bgraokmsuh

Project Link: https://github.com/bgraokmush/ElasticSearch-Aggregation

(back to top)

🙏 Acknowledgments

(back to top)