From 4ea00c2cd79a52df877288e542a6e2a12347b6b9 Mon Sep 17 00:00:00 2001
From: ktx-kirtan <124270523+ktx-kirtan@users.noreply.github.com>
Date: Mon, 18 Nov 2024 22:19:21 +0530
Subject: [PATCH] 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 <321201+jsumners@users.noreply.github.com>
* Update docs/transports.md
Co-authored-by: James Sumners <321201+jsumners@users.noreply.github.com>
---------
Co-authored-by: James Sumners <321201+jsumners@users.noreply.github.com>
---
docs/transports.md | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/docs/transports.md b/docs/transports.md
index c32c8477c..63d591096 100644
--- 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')
```
+
+### @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).
### pino-airbrake-transport