docs: add @openobserve/openobserve-pino transports (#2078)

* add @openobserve/openobserve-pino to transports.md * Update transports.md * Update docs/transports.md Co-authored-by: James Sumners <[email protected]> * Update docs/transports.md Co-authored-by: James Sumners <[email protected]> --------- Co-authored-by: James Sumners <[email protected]>
pinojs · Nov 18, 2024 · 4ea00c2 · 4ea00c2
1 parent 3505a68
commit 4ea00c2
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/docs/transports.md b/docs/transports.md
@@ -426,6 +426,7 @@ PRs to this document are welcome for any new transports!
 + [@axiomhq/pino](#@axiomhq/pino)
 + [@logtail/pino](#@logtail/pino)
 + [@macfja/pino-fingers-crossed](#macfja-pino-fingers-crossed)
++ [@openobserve/pino-openobserve](#pino-openobserve)
 + [pino-airbrake-transport](#pino-airbrake-transport)
 + [pino-axiom](#pino-axiom)
 + [pino-datadog-transport](#pino-datadog-transport)
@@ -525,6 +526,35 @@ logger.info('Will NOT appear')
 logger.info({ [enable]: false }, 'Will appear immedialty')
 logger.info('Will NOT appear')
 ```
+<a id="pino-openobserve"></a>
+### @openobserve/pino-openobserve
+
+[@openobserve/pino-openobserve](https://github.com/openobserve/pino-openobserve) is a 
+Pino v7+ transport that will send logs to an 
+[OpenObserve](https://openobserve.ai) instance.
+
+```
+const pino = require('pino');
+const OpenobserveTransport = require('@openobserve/pino-openobserve');
+
+const logger = pino({
+  level: 'info',
+  transport: {
+    target: OpenobserveTransport,
+    options: {
+      url: 'https://your-openobserve-server.com',
+      organization: 'your-organization',
+      streamName: 'your-stream',
+      auth: {
+        username: 'your-username',
+        password: 'your-password',
+      },
+    },
+  },
+});
+```
+
+For full documentation check the [README](https://github.com/openobserve/pino-openobserve).
 
 <a id="pino-airbrake-transport"></a>
 ### pino-airbrake-transport