autotel-plugins 0.12.1 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -63,8 +63,37 @@ For databases/ORMs with **working** official instrumentation, **use those direct
63
63
 
64
64
  ## Installation
65
65
 
66
+ Install the package and **autotel** (required for all plugins):
67
+
66
68
  ```bash
67
- npm install autotel-plugins
69
+ npm install autotel autotel-plugins
70
+ ```
71
+
72
+ ### What to install per plugin
73
+
74
+ Each plugin needs the core packages above plus the library (and optional OTel instrumentation) you use:
75
+
76
+ | Plugin | Install |
77
+ | ------------ | -------------------------------------------------------------------------------------------------------------------------- |
78
+ | **Mongoose** | `autotel` + `autotel-plugins` + `mongoose` |
79
+ | **Drizzle** | `autotel` + `autotel-plugins` + `drizzle-orm` + your driver (e.g. `postgres`, `mysql2`, `better-sqlite3`) |
80
+ | **BigQuery** | `autotel` + `autotel-plugins` + `@google-cloud/bigquery` |
81
+ | **Kafka** | `autotel` + `autotel-plugins` + `kafkajs`. Optional: `@opentelemetry/instrumentation-kafkajs` for producer/consumer spans. |
82
+
83
+ Examples:
84
+
85
+ ```bash
86
+ # Mongoose
87
+ npm install autotel autotel-plugins mongoose
88
+
89
+ # Drizzle (e.g. Postgres)
90
+ npm install autotel autotel-plugins drizzle-orm postgres
91
+
92
+ # BigQuery
93
+ npm install autotel autotel-plugins @google-cloud/bigquery
94
+
95
+ # Kafka (with optional official instrumentation)
96
+ npm install autotel autotel-plugins kafkajs @opentelemetry/instrumentation-kafkajs
68
97
  ```
69
98
 
70
99
  ## Currently Supported