build-my-meta
v1.1.0
Published
A flexible and powerful package for logging metadata from API calls, compatible with multiple databases (MongoDB, PostgreSQL, MySQL, etc.).
Downloads
121
Maintainers
Readme
Build-My-Meta (Metadata-Logger)
Build-My-Meta is a powerful and flexible metadata logging package for API calls, designed to support multiple databases. This package automatically logs metadata related to API requests and responses, making it easy to monitor user actions, performance, and errors.
🦒 Supported Databases
- MongoDB
- PostgreSQL
- MySQL
- Firebase Realtime Database / Firestore
- SQLite
- Cassandra
- Neo4j
- MariaDB
- Redis (Coming soon)
- Oracle Database (Coming soon)
🦓 Supported Frameworks & Environments
- Node.js
- Express.js
- Next.js (Manual Edition Only)
- Fastify (Coming Soon)
🐒 Installation
Install the package using npm:
npm install build-my-meta
🐸 Getting Started
Basic Setup
In your main server file (e.g., app.js
), import and configure the BuildMyMeta
middleware. Based on the database type, pass your initialized database instance to the BuildMyMeta
middleware.
🐺 Documentation on Website:
Below are some examples of how to configure and use the packages, but they might not be available latest, or might not have detailed step by step process to understand the uses. Visit our website documentation for better understanding.
Website Documentation Link: https://.../build-my-meta
~🦈 Backend (Database-Specific Setup Examples)
1. MongoDB ~ 🌿Weblink
{#mongodb}
2. PostgreSQL ~ 🌿Weblink
{#postgresql}
3. MySQL ~ 🌿Weblink
{#mysql}
4. Firebase Realtime Database / Firestore ~ 🌿Weblink
{#firebase}
5. SQLite ~ 🌿Weblink
{#sqlite}
6. Cassandra ~ 🌿Weblink
{#cassandra}
7. Neo4j ~ 🌿Weblink
{#neo4j}
8. MariaDB ~ 🌿Weblink
{#mariadb}
~ 🐳 Frontend (Next.js) ~ 🌿Weblink
In Next.js, you can use BuildMyMeta
middleware within custom API routes under pages/api
. This allows you to set up automatic or manual metadata logging as needed.
Notes for Next.js
- Environment Variables: Store sensitive information in
.env
files and avoid exposing them to the client side. - Database Connection: Ensure your database connection is established before logging, as shown in the examples above.
~ 🪸 Error Handling and Logs
Error logs are stored in the metaError.json
file if any issues occur during metadata logging.
~ 🐦🔥 Troubleshooting
- Missing Database Instance: Ensure to pass an initialized instance (e.g.,
mongoose
for MongoDB). - Unsupported Database: Verify that the database type is supported.
License
This package is licensed under the MIT License.